{ "openapi": "3.1.1", "components": { "examples": {}, "headers": {}, "parameters": {}, "requestBodies": {}, "responses": {}, "schemas": { "APIPowerRole": { "type": "string", "enum": ["OWNER", "ADMIN", "MEMBER"] }, "APIRateLimitTier": { "type": "string", "enum": ["TIER_1", "TIER_2", "TIER_3", "TIER_4", "TIER_5", "TIER_6", "UNLIMITED"] }, "APIBaseAPIKey": { "properties": { "active": { "type": "boolean", "description": "Whether the API key is active and can be used for authentication" }, "team_id": { "type": "string", "description": "Team ID" }, "name": { "type": "string", "description": "Name of the API key" }, "rate_limit_tier": { "$ref": "#/components/schemas/APIRateLimitTier", "description": "Rate limit tier of the API key" }, "power_role": { "$ref": "#/components/schemas/APIPowerRole", "description": "Power role of the API key" }, "expires_at": { "type": ["string", "null"], "format": "date-time", "description": "When the API key expires" }, "description": { "type": ["string", "null"], "description": "Description of the API key" }, "created_by_user_id": { "type": "string", "description": "ID of the user that created the API key" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the API key was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the API key was created" }, "id": { "type": "string", "description": "Unique identifier for the API key" } }, "required": [ "active", "team_id", "name", "rate_limit_tier", "power_role", "expires_at", "description", "created_by_user_id", "updated_at", "created_at", "id" ], "type": "object" }, "BadRequestProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "field": { "type": "string" }, "value": {}, "expected": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "Record_string.unknown_": { "properties": {}, "additionalProperties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T" }, "ValidationProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "fields": { "$ref": "#/components/schemas/Record_string.unknown_" }, "field": { "type": "string" }, "value": {} }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "UnauthorizedProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "MissingScopesProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "requiredScopes": { "items": { "type": "string" }, "type": "array" }, "currentScopes": { "items": { "type": "string" }, "type": "array" } }, "required": ["type", "title", "status", "detail", "requiredScopes", "currentScopes"], "type": "object", "additionalProperties": false }, "ForbiddenProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "NotFoundProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "ConflictProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "GoneProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "UnprocessableEntityProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "field": { "type": "string" } }, "required": ["message", "field"], "type": "object" }, "type": "array" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "RateLimitProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "limit": { "type": "number", "format": "double" }, "remaining": { "type": "number", "format": "double" }, "reset_at": { "type": "string" }, "retry_after": { "type": "number", "format": "double" } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "reset_at", "retry_after"], "type": "object", "additionalProperties": false }, "InternalProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "ServiceUnavailableProblemDetails": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "number", "format": "double" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": ["type", "title", "status", "detail"], "type": "object", "additionalProperties": false }, "AnyProblemDetails": { "anyOf": [ { "$ref": "#/components/schemas/BadRequestProblemDetails" }, { "$ref": "#/components/schemas/ValidationProblemDetails" }, { "$ref": "#/components/schemas/UnauthorizedProblemDetails" }, { "$ref": "#/components/schemas/MissingScopesProblemDetails" }, { "$ref": "#/components/schemas/ForbiddenProblemDetails" }, { "$ref": "#/components/schemas/NotFoundProblemDetails" }, { "$ref": "#/components/schemas/ConflictProblemDetails" }, { "$ref": "#/components/schemas/GoneProblemDetails" }, { "$ref": "#/components/schemas/UnprocessableEntityProblemDetails" }, { "$ref": "#/components/schemas/RateLimitProblemDetails" }, { "$ref": "#/components/schemas/InternalProblemDetails" }, { "$ref": "#/components/schemas/ServiceUnavailableProblemDetails" } ] }, "APIErrorResponse": { "$ref": "#/components/schemas/AnyProblemDetails", "description": "API Error Response\n\nAll API errors follow the RFC 9457 Problem Details for HTTP APIs standard.\nResponses will have Content-Type: application/problem+json" }, "WorkOrderSupportedActionType": { "enum": [ "VIEW_WORK_ORDER", "UPDATE_WORK_ORDER", "DELETE_WORK_ORDER", "APPROVE_WORK_ORDER", "START_WORK_ORDER", "COMPLETE_WORK_ORDER", "CANCEL_WORK_ORDER", "ADD_CHARGES", "PICK_STOCK" ], "type": "string" }, "APISupportedAction_WorkOrderSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/WorkOrderSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIProductType": { "type": "string", "enum": ["STANDARD", "ASSEMBLY", "VIRTUAL_BUNDLE", "DIGITAL", "UOM"] }, "LocationKind": { "type": "string", "enum": ["STATIC", "LPN", "TOTE"] }, "APIBaseProductStock": { "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized: label (null = eaches)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized: how many eaches per UoM unit (null = eaches)" }, "uom_profile_id": { "type": ["string", "null"], "description": "Live UoM profile ID (null = eaches)" }, "location_kind": { "$ref": "#/components/schemas/LocationKind", "description": "The kind of location (denormalized for dynamic view actions)" }, "location_pickable": { "type": "boolean", "description": "Whether the location is pickable (denormalized from location for performance)" }, "location_sellable": { "type": "boolean", "description": "Whether the location is sellable (denormalized from location for performance)" }, "parent_location_name": { "type": ["string", "null"], "description": "Parent location name for LPN/TOTE display" }, "location_name": { "type": "string", "description": "Location name" }, "product_type": { "$ref": "#/components/schemas/APIProductType", "description": "Denormalized: product type (for UoM selection)" }, "image_url": { "type": ["string", "null"], "description": "Product image URL" }, "sku": { "type": ["string", "null"], "description": "Product SKU" }, "name": { "type": "string", "description": "Product name" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "team_id": { "type": "string", "deprecated": true }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns the product represented by this stock" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team that owns the warehouse/location" }, "location_id": { "type": "string", "description": "Location ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID (nullable for orphaned stock after delegation deletion)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the stock record was created" }, "received_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was physically received from supplier (for FIFO)" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date" }, "lot_code": { "type": ["string", "null"], "description": "Lot code" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was last updated" }, "on_hand": { "type": "number", "format": "double", "description": "Quantity on hand, always in base stock units (eaches)" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "location_kind", "location_pickable", "location_sellable", "parent_location_name", "location_name", "product_type", "image_url", "sku", "name", "warehouse_name", "warehouse_id", "team_id", "merchant_team_id", "fulfiller_team_id", "location_id", "product_id", "created_at", "received_at", "expiration_date", "lot_code", "updated_at", "on_hand", "id" ], "type": "object" }, "APIBaseWorkOrderLineItemPick": { "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "quantity": { "type": "number", "format": "double" }, "lot_code": { "type": ["string", "null"] }, "expiration_date": { "type": ["string", "null"], "format": "date-time" }, "uom_profile_id": { "type": ["string", "null"] }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double" }, "uom_label": { "type": ["string", "null"] }, "product_stock_id": { "type": ["string", "null"] } }, "required": [ "id", "created_at", "quantity", "lot_code", "expiration_date", "uom_profile_id", "uom_multiplier_to_eaches", "uom_label", "product_stock_id" ], "type": "object", "additionalProperties": false }, "WorkOrderLineItemWithProductStock": { "properties": { "uom_profile_id": { "type": ["string", "null"], "description": "UoM profile ID for this line item (null = eaches)" }, "work_order_id": { "type": "string", "description": "ID of the work order this line item belongs to" }, "deducted_quantity": { "type": "number", "format": "double", "description": "Total quantity already deducted/picked for this line item" }, "product_stock_id": { "type": ["string", "null"], "description": "ID of the product stock allocated to this line item" }, "product_id": { "type": ["string", "null"], "description": "ID of the product this line item belongs to" }, "product_type": { "$ref": "#/components/schemas/APIProductType", "description": "Product type (denormalized for historical accuracy)" }, "image_url": { "type": ["string", "null"], "description": "Image URL of the product (denormalized for historical accuracy)" }, "sku": { "type": ["string", "null"], "description": "SKU of the product (denormalized for historical accuracy)" }, "name": { "type": "string", "description": "Name of the product (denormalized for historical accuracy)" }, "quantity": { "type": "number", "format": "double", "description": "Quantity of the item" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the work order line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the work order line item was created" }, "id": { "type": "string", "description": "Unique identifier" }, "product_stock": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseProductStock" }, { "type": "null" } ] }, "picks": { "items": { "$ref": "#/components/schemas/APIBaseWorkOrderLineItemPick" }, "type": "array" } }, "required": [ "uom_profile_id", "work_order_id", "deducted_quantity", "product_stock_id", "product_id", "product_type", "image_url", "sku", "name", "quantity", "updated_at", "created_at", "id", "product_stock", "picks" ], "type": "object", "additionalProperties": false }, "APIWorkOrderType": { "type": "string", "enum": ["ASSEMBLY", "CUSTOM"] }, "APIWorkOrderStatus": { "type": "string", "enum": ["AWAITING_APPROVAL", "APPROVED", "IN_PROGRESS", "COMPLETED", "CANCELLED"] }, "Incoterm": { "type": "string", "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "DeliveryConfirmation": { "type": "string", "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "NoInsurancePolicy": { "properties": { "mode": { "type": "string", "enum": ["none"], "nullable": false } }, "required": ["mode"], "type": "object", "additionalProperties": false }, "FixedAmountInsurancePolicy": { "properties": { "mode": { "type": "string", "enum": ["fixed_amount"], "nullable": false }, "fixed_amount": { "type": "number", "format": "double" } }, "required": ["mode", "fixed_amount"], "type": "object", "additionalProperties": false }, "InsurancePolicy": { "anyOf": [ { "$ref": "#/components/schemas/NoInsurancePolicy" }, { "$ref": "#/components/schemas/FixedAmountInsurancePolicy" } ] }, "NonDeliveryOption": { "type": "string", "enum": ["ABANDON", "RETURN"] }, "RestrictionType": { "type": "string", "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "ContentsType": { "type": "string", "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "CommercialInvoiceTransactionReason": { "type": "string", "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "WorkOrderConfigFields": { "description": "Work-order packing/QA and shipping config fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "WorkOrderConfig": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderConfigFields" } ], "nullable": true }, "APIExpandedWorkOrderWithActions": { "properties": { "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "pick_list_urls": { "items": { "type": "string" }, "type": "array", "description": "URLs of generated pick list PDFs" }, "work_order_number": { "type": "string", "description": "Human-readable work order number, auto-incremented per fulfiller team" }, "receiving_location_name": { "type": ["string", "null"], "description": "Denormalized: The receiving location name" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "staging_location_name": { "type": ["string", "null"], "description": "Denormalized: The staging location name" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller teams name" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant teams name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team assigned to the work order" }, "vendor_name": { "type": ["string", "null"], "description": "Name of the vendor used for the work order" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor used for the work order" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team that requested the work order" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse assigned to the work order" }, "requested_by_user_name": { "type": ["string", "null"], "description": "Denormalized: The name of the user who requested the work order" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user that requested the work order" }, "assembly_product_image_url": { "type": ["string", "null"], "description": "Denormalized: The assembly product image URL" }, "assembly_product_name": { "type": ["string", "null"], "description": "Denormalized: The assembly product name" }, "assembly_product_sku": { "type": ["string", "null"], "description": "Denormalized: The assembly product SKU" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product being assembled" }, "assembled_quantity": { "type": "number", "format": "double", "description": "Quantity of the product that was assembled" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity of the product to assemble" }, "assembly_details": { "type": ["string", "null"], "description": "Details about the assembly process" }, "packing_details": { "type": ["string", "null"], "description": "Details about the packing process" }, "config": { "$ref": "#/components/schemas/WorkOrderConfig", "description": "Work-order-scoped packing and shipping configuration overrides" }, "currency": { "type": "string", "description": "Currency for the work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "name": { "type": ["string", "null"], "description": "Name of the work order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized name of the user who finalized packing" }, "packed_by_user_id": { "type": ["string", "null"], "description": "User who most recently finalized packing" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was finalized" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was started" }, "packing_revision": { "type": "number", "format": "double", "description": "Monotonic authoritative packing-state revision" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was completed" }, "assembled_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was assembled by the assembler" }, "picked_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was picked" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested by the merchant" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was scheduled to be completed by the fulfiller" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the work order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the work order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "work_order_line_items": { "items": { "$ref": "#/components/schemas/WorkOrderLineItemWithProductStock" }, "type": "array" }, "total_line_items": { "type": "number", "format": "double" }, "total_quantity": { "type": "number", "format": "double" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_WorkOrderSupportedActionType_" }, "type": "array" } }, "required": [ "description", "pick_list_urls", "work_order_number", "receiving_location_name", "receiving_location_id", "staging_location_name", "staging_location_id", "warehouse_name", "fulfiller_team_name", "merchant_team_name", "fulfiller_team_id", "vendor_name", "vendor_id", "merchant_team_id", "warehouse_id", "requested_by_user_name", "requested_by_user_id", "assembly_product_image_url", "assembly_product_name", "assembly_product_sku", "assembly_product_id", "assembled_quantity", "quantity_to_assemble", "assembly_details", "packing_details", "config", "currency", "priority", "status", "type", "name", "packed_by_user_name", "packed_by_user_id", "packing_completed_at", "packing_started_at", "packing_revision", "completed_at", "assembled_at", "picked_at", "requested_by", "scheduled_by", "updated_at", "created_at", "id", "work_order_line_items", "total_line_items", "total_quantity", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIWeightUnit": { "type": "string", "enum": ["G", "KG", "OZ", "LB"] }, "APIBasePackageLineItem": { "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized from UoM profile — human-readable label (e.g. Case, Pack)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized from UoM profile — how many eaches per UoM unit" }, "uom_profile_id": { "type": ["string", "null"], "description": "UoM packaging level that was packed (null = eaches / legacy)" }, "work_order_line_item_id": { "type": ["string", "null"], "description": "Work order line item ID (for work-order packages)" }, "core_fulfillment_order_line_item_id": { "type": ["string", "null"], "description": "Core fulfillment order line item ID (for fulfillment order packages)" }, "printed_commodity_identifier": { "type": ["string", "null"], "description": "International commodity code (fallback to product if null)" }, "eccn": { "type": ["string", "null"], "description": "Export Control Classification Number (fallback to product if null)" }, "manufacturer": { "type": ["string", "null"], "description": "Item manufacturer (fallback to product if null)" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized Tariff Schedule code (fallback to product if null)" }, "country_of_origin": { "type": ["string", "null"], "description": "Country of origin for customs (fallback to product if null)" }, "customs_value_currency": { "type": ["string", "null"], "description": "Customs value currency (defaults to USD)" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Customs value for international shipments (fallback to product if null)" }, "customs_description": { "type": ["string", "null"], "description": "Customs description for international shipments (fallback to product if null)" }, "weight_unit": { "description": "Weight unit for standalone packages (fallback to product weight unit if null)", "type": ["string", "null"], "enum": ["G", "KG", "OZ", "LB"] }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight for standalone packages (fallback to product weight if null)" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date for the product" }, "lot_code": { "type": ["string", "null"], "description": "Lot code for the product" }, "package_id": { "type": "string", "description": "Package ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "quantity": { "type": "number", "format": "double", "description": "Quantity in the package" }, "image_url": { "type": ["string", "null"], "description": "Product image URL" }, "sku": { "type": ["string", "null"], "description": "Product SKU" }, "name": { "type": "string", "description": "Product name" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "work_order_line_item_id", "core_fulfillment_order_line_item_id", "printed_commodity_identifier", "eccn", "manufacturer", "hs_code", "country_of_origin", "customs_value_currency", "customs_value", "customs_description", "weight_unit", "weight", "expiration_date", "lot_code", "package_id", "product_id", "quantity", "image_url", "sku", "name", "updated_at", "created_at", "id" ], "type": "object" }, "APIBasePackageAttachment": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "When the attachment was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the attachment was last updated" }, "package_id": { "type": "string", "description": "ID of the package this attachment belongs to" }, "file_id": { "type": "string", "description": "ID of the file" }, "file_name": { "type": ["string", "null"], "description": "Denormalized file name" }, "file_url": { "type": ["string", "null"], "description": "Denormalized file URL" }, "file_thumbnail_url": { "type": ["string", "null"], "description": "Denormalized file thumbnail URL" }, "description": { "type": ["string", "null"], "description": "Description of the attachment" } }, "required": [ "id", "created_at", "updated_at", "package_id", "file_id", "file_name", "file_url", "file_thumbnail_url", "description" ], "type": "object", "additionalProperties": false }, "APIPackageStatus": { "type": "string", "enum": ["PENDING", "PICKED", "PACKED", "FULFILLED", "CANCELLED", "CLOSED"] }, "APIMeasurementUnit": { "type": "string", "enum": ["MM", "CM", "M", "IN", "FT"] }, "APIPackageType": { "type": "string", "enum": ["FULFILLMENT_ORDER", "WORK_ORDER", "STANDALONE", "RETURN"] }, "APIPackageConfig": { "description": "Public API package-level config response fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "APICarrierType": { "type": "string", "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "APIAvailableLabelRate": { "properties": { "currency": { "type": "string", "description": "Currency code for the quoted amount" }, "amount": { "type": "number", "format": "double", "description": "Quoted amount for the rate" }, "service_name": { "type": "string", "description": "Service display name" }, "carrier_name": { "type": "string", "description": "Carrier display name" }, "service_id": { "type": "string", "description": "Normalized service identifier" }, "carrier_id": { "type": "string", "description": "Normalized carrier identifier" }, "carrier_integration_type": { "$ref": "#/components/schemas/APICarrierType", "description": "Carrier integration type" }, "carrier_integration_id": { "type": "string", "description": "Carrier integration identifier" }, "estimated_days": { "type": ["number", "null"], "format": "double" }, "delivery_date_guaranteed": { "type": "boolean" }, "delivery_date": { "type": ["string", "null"] }, "provider_rate_id": { "type": "string" } }, "required": [ "currency", "amount", "service_name", "carrier_name", "service_id", "carrier_id", "carrier_integration_type", "carrier_integration_id" ], "type": "object" }, "APILabelPurchaseDetail": { "properties": { "carrier_type": { "$ref": "#/components/schemas/APICarrierType", "description": "Carrier integration type associated with the failure" }, "message": { "type": "string", "description": "Carrier-specific failure message" } }, "required": ["carrier_type", "message"], "type": "object" }, "APILabelPurchaseError": { "properties": { "detailed_errors": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/APILabelPurchaseDetail" }, "description": "Carrier-specific failures collected while fetching or buying rates" }, "available_rates": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/APIAvailableLabelRate" }, "description": "Alternative rates that may still be available for purchase" }, "message": { "type": "string", "description": "Human-readable label purchase failure message" } }, "required": ["detailed_errors", "available_rates", "message"], "type": "object" }, "APIShippingLabelShipmentStatus": { "type": "string", "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "APIWorkOrderPackage": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "idempotency_key": { "type": ["string", "null"], "description": "Stable package identity used to reconcile unsaved packing state" }, "created_at": { "type": "string", "format": "date-time", "description": "When the package was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was last updated" }, "name": { "type": "string", "description": "Package name" }, "manifested_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was manifested" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was shipped" }, "status": { "$ref": "#/components/schemas/APIPackageStatus", "description": "Package status" }, "packing_slip_url": { "type": ["string", "null"], "description": "Packing slip URL" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit" }, "type": { "$ref": "#/components/schemas/APIPackageType", "description": "Type" }, "length": { "type": "number", "format": "double", "description": "Length" }, "width": { "type": "number", "format": "double", "description": "Width" }, "height": { "type": "number", "format": "double", "description": "Height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Weight" }, "total_customs_value": { "type": ["number", "null"], "format": "double", "description": "Total customs value" }, "config": { "description": "Package-level shipping config overrides using PackageConfigSchema", "oneOf": [ { "$ref": "#/components/schemas/APIPackageConfig" }, { "type": "null" } ] }, "rate_error_data": { "description": "Structured rate error data", "oneOf": [ { "$ref": "#/components/schemas/APILabelPurchaseError" }, { "type": "null" } ] }, "error_message": { "type": ["string", "null"], "description": "Error message" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "provider_rate_id": { "type": ["string", "null"], "description": "Exact selected provider rate, when available." }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID - when present, creates `FULFILLMENT_ORDER` package with automatic address fallbacks" }, "work_order_id": { "type": ["string", "null"], "description": "Work order ID - when present (without fulfillment_order_id), creates `WORK_ORDER` package" }, "return_id": { "type": ["string", "null"], "description": "Return ID - when present, creates `RETURN` package" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID" }, "scan_form_id": { "type": ["string", "null"], "description": "Scan form ID" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carton_name": { "type": ["string", "null"], "description": "Carton name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "bulk_ship_template_package_id": { "type": ["string", "null"], "description": "Bulk ship template package ID" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse ID" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_address1": { "type": ["string", "null"], "description": "From address street 1" }, "from_address_address2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address ZIP" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_email": { "type": ["string", "null"], "description": "From address email" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_address1": { "type": ["string", "null"], "description": "To address street 1" }, "to_address_address2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address ZIP" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_email": { "type": ["string", "null"], "description": "To address email" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the shipment should be delivered (denormalized from FulfillmentOrder)" }, "line_item_hash": { "type": "string", "description": "Hash of line items for deduplication/matching" }, "total_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of all line items" }, "unique_line_item_count": { "type": "number", "format": "double", "description": "Number of unique line items" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string for the requested carrier/service (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "shipping_label_tracking_code": { "type": ["string", "null"], "description": "Tracking code from shipping label" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Tracking URL from shipping label" }, "shipping_label_formatted_service": { "type": ["string", "null"], "description": "Formatted service display string from shipping label (what was actually bought)" }, "shipping_label_url": { "type": ["string", "null"], "description": "Label URL from shipping label" }, "shipment_status": { "description": "Shipment status from shipping label", "type": ["string", "null"], "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "package_line_items": { "items": { "$ref": "#/components/schemas/APIBasePackageLineItem" }, "type": "array" }, "package_attachments": { "items": { "$ref": "#/components/schemas/APIBasePackageAttachment" }, "type": "array" } }, "required": [ "id", "idempotency_key", "created_at", "updated_at", "name", "manifested_at", "shipped_at", "status", "packing_slip_url", "measurement_unit", "type", "length", "width", "height", "weight_unit", "weight", "total_customs_value", "config", "rate_error_data", "error_message", "carrier_id", "service_id", "picking_session_id", "fulfillment_order_id", "work_order_id", "return_id", "carton_id", "shipping_label_id", "scan_form_id", "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "carton_name", "fulfiller_team_id", "fulfiller_team_name", "bulk_ship_id", "bulk_ship_template_package_id", "warehouse_id", "warehouse_name", "merchant_team_id", "merchant_team_name", "from_address_name", "from_address_company", "from_address_address1", "from_address_address2", "from_address_city", "from_address_state", "from_address_country", "from_address_zip", "from_address_phone", "from_address_email", "to_address_name", "to_address_company", "to_address_address1", "to_address_address2", "to_address_city", "to_address_state", "to_address_country", "to_address_zip", "to_address_phone", "to_address_email", "rate_shop_id", "rate_shop_name", "deliver_by", "line_item_hash", "total_item_quantity", "unique_line_item_count", "formatted_service", "shipping_label_tracking_code", "shipping_label_tracking_url", "shipping_label_formatted_service", "shipping_label_url", "shipment_status", "package_line_items", "package_attachments" ], "type": "object", "additionalProperties": false }, "APIWorkOrderPackagesOutput": { "properties": { "packages": { "items": { "$ref": "#/components/schemas/APIWorkOrderPackage" }, "type": "array" } }, "required": ["packages"], "type": "object", "additionalProperties": false }, "APIMinimalWorkOrder": { "properties": { "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "pick_list_urls": { "items": { "type": "string" }, "type": "array", "description": "URLs of generated pick list PDFs" }, "work_order_number": { "type": "string", "description": "Human-readable work order number, auto-incremented per fulfiller team" }, "receiving_location_name": { "type": ["string", "null"], "description": "Denormalized: The receiving location name" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "staging_location_name": { "type": ["string", "null"], "description": "Denormalized: The staging location name" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller teams name" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant teams name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team assigned to the work order" }, "vendor_name": { "type": ["string", "null"], "description": "Name of the vendor used for the work order" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor used for the work order" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team that requested the work order" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse assigned to the work order" }, "requested_by_user_name": { "type": ["string", "null"], "description": "Denormalized: The name of the user who requested the work order" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user that requested the work order" }, "assembly_product_image_url": { "type": ["string", "null"], "description": "Denormalized: The assembly product image URL" }, "assembly_product_name": { "type": ["string", "null"], "description": "Denormalized: The assembly product name" }, "assembly_product_sku": { "type": ["string", "null"], "description": "Denormalized: The assembly product SKU" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product being assembled" }, "assembled_quantity": { "type": "number", "format": "double", "description": "Quantity of the product that was assembled" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity of the product to assemble" }, "assembly_details": { "type": ["string", "null"], "description": "Details about the assembly process" }, "packing_details": { "type": ["string", "null"], "description": "Details about the packing process" }, "config": { "$ref": "#/components/schemas/WorkOrderConfig", "description": "Work-order-scoped packing and shipping configuration overrides" }, "currency": { "type": "string", "description": "Currency for the work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "name": { "type": ["string", "null"], "description": "Name of the work order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized name of the user who finalized packing" }, "packed_by_user_id": { "type": ["string", "null"], "description": "User who most recently finalized packing" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was finalized" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was started" }, "packing_revision": { "type": "number", "format": "double", "description": "Monotonic authoritative packing-state revision" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was completed" }, "assembled_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was assembled by the assembler" }, "picked_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was picked" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested by the merchant" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was scheduled to be completed by the fulfiller" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the work order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the work order was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "description", "pick_list_urls", "work_order_number", "receiving_location_name", "receiving_location_id", "staging_location_name", "staging_location_id", "warehouse_name", "fulfiller_team_name", "merchant_team_name", "fulfiller_team_id", "vendor_name", "vendor_id", "merchant_team_id", "warehouse_id", "requested_by_user_name", "requested_by_user_id", "assembly_product_image_url", "assembly_product_name", "assembly_product_sku", "assembly_product_id", "assembled_quantity", "quantity_to_assemble", "assembly_details", "packing_details", "config", "currency", "priority", "status", "type", "name", "packed_by_user_name", "packed_by_user_id", "packing_completed_at", "packing_started_at", "packing_revision", "completed_at", "assembled_at", "picked_at", "requested_by", "scheduled_by", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "PaginationMeta": { "description": "Pagination metadata interface", "properties": { "page": { "type": "number", "format": "double", "description": "Current page (0-based)" }, "page_size": { "type": "number", "format": "double", "description": "Items per page" }, "has_next_page": { "type": "boolean", "description": "Whether there is a next page" }, "has_previous_page": { "type": "boolean", "description": "Whether there is a previous page" }, "start_index": { "type": "number", "format": "double", "description": "First item index on current page (0-based)" }, "end_index": { "type": "number", "format": "double", "description": "Last item index on current page (0-based)" } }, "required": ["page", "page_size", "has_next_page", "has_previous_page"], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalWorkOrder_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalWorkOrder" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyWorkOrdersResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalWorkOrder_", "description": "Response type for get-many operations" }, "APISortDirection": { "type": "string", "enum": ["asc", "desc"], "description": "Shared sort/order types used across handler input schemas.\n\nDefining these centrally avoids inline `z.enum([\"asc\", \"desc\"])` literals\nsprinkled across handler input schemas; callers should reference\n`APISortDirection` via `z.nativeEnum(APISortDirection)` instead.\nAPI values intentionally stay lowercase to match persisted table-filter state." }, "APIExpandedWorkOrder": { "properties": { "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "pick_list_urls": { "items": { "type": "string" }, "type": "array", "description": "URLs of generated pick list PDFs" }, "work_order_number": { "type": "string", "description": "Human-readable work order number, auto-incremented per fulfiller team" }, "receiving_location_name": { "type": ["string", "null"], "description": "Denormalized: The receiving location name" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "staging_location_name": { "type": ["string", "null"], "description": "Denormalized: The staging location name" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller teams name" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant teams name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team assigned to the work order" }, "vendor_name": { "type": ["string", "null"], "description": "Name of the vendor used for the work order" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor used for the work order" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team that requested the work order" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse assigned to the work order" }, "requested_by_user_name": { "type": ["string", "null"], "description": "Denormalized: The name of the user who requested the work order" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user that requested the work order" }, "assembly_product_image_url": { "type": ["string", "null"], "description": "Denormalized: The assembly product image URL" }, "assembly_product_name": { "type": ["string", "null"], "description": "Denormalized: The assembly product name" }, "assembly_product_sku": { "type": ["string", "null"], "description": "Denormalized: The assembly product SKU" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product being assembled" }, "assembled_quantity": { "type": "number", "format": "double", "description": "Quantity of the product that was assembled" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity of the product to assemble" }, "assembly_details": { "type": ["string", "null"], "description": "Details about the assembly process" }, "packing_details": { "type": ["string", "null"], "description": "Details about the packing process" }, "config": { "$ref": "#/components/schemas/WorkOrderConfig", "description": "Work-order-scoped packing and shipping configuration overrides" }, "currency": { "type": "string", "description": "Currency for the work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "name": { "type": ["string", "null"], "description": "Name of the work order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized name of the user who finalized packing" }, "packed_by_user_id": { "type": ["string", "null"], "description": "User who most recently finalized packing" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was finalized" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was started" }, "packing_revision": { "type": "number", "format": "double", "description": "Monotonic authoritative packing-state revision" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was completed" }, "assembled_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was assembled by the assembler" }, "picked_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was picked" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested by the merchant" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was scheduled to be completed by the fulfiller" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the work order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the work order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "work_order_line_items": { "items": { "$ref": "#/components/schemas/WorkOrderLineItemWithProductStock" }, "type": "array" }, "total_line_items": { "type": "number", "format": "double" }, "total_quantity": { "type": "number", "format": "double" } }, "required": [ "description", "pick_list_urls", "work_order_number", "receiving_location_name", "receiving_location_id", "staging_location_name", "staging_location_id", "warehouse_name", "fulfiller_team_name", "merchant_team_name", "fulfiller_team_id", "vendor_name", "vendor_id", "merchant_team_id", "warehouse_id", "requested_by_user_name", "requested_by_user_id", "assembly_product_image_url", "assembly_product_name", "assembly_product_sku", "assembly_product_id", "assembled_quantity", "quantity_to_assemble", "assembly_details", "packing_details", "config", "currency", "priority", "status", "type", "name", "packed_by_user_name", "packed_by_user_id", "packing_completed_at", "packing_started_at", "packing_revision", "completed_at", "assembled_at", "picked_at", "requested_by", "scheduled_by", "updated_at", "created_at", "id", "work_order_line_items", "total_line_items", "total_quantity" ], "type": "object", "additionalProperties": false }, "APIWorkOrderLineItemInput": { "description": "A work order line as the create and update APIs accept it.\n\nA line with a `product_id` is a catalog line: its name, SKU and image come from the product, and\nany submitted values are ignored. A line with `product_id: null` is a custom item and must carry\na `name`. When updating an existing line, omit `product_id` to keep the line's product.", "properties": { "work_order_line_item_id": { "type": "string", "description": "ID of existing line item (for updates)" }, "product_id": { "type": ["string", "null"], "description": "ID of the product. Null for a custom item. An existing line's product cannot be changed." }, "product_stock_id": { "type": ["string", "null"], "description": "ID of the product stock" }, "quantity": { "type": "number", "format": "double", "description": "Quantity of the item, in eaches" }, "name": { "type": "string", "description": "Item name. Required for a new custom item (product_id: null); ignored for catalog products." }, "sku": { "type": ["string", "null"], "description": "Item SKU for a custom item; ignored for catalog products." }, "image_url": { "type": ["string", "null"], "description": "Item image URL (http or https) for a custom item; ignored for catalog products." }, "uom_profile_id": { "type": ["string", "null"], "description": "ID of the product's UoM profile the quantity was entered in (null = eaches). Quantity is always in eaches." } }, "required": ["quantity"], "type": "object", "additionalProperties": false }, "ShipOSCreateWorkOrderInput": { "description": "ShipOS-specific create input for work orders.\nSection data is managed through dedicated attachments/components/packages endpoints.", "properties": { "name": { "type": ["string", "null"], "description": "Name of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order (higher number = higher priority)" }, "currency": { "type": "string", "description": "Currency for the work order" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order should be completed by" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested" }, "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "packing_details": { "type": ["string", "null"], "description": "Packing instructions or details" }, "assembly_details": { "type": ["string", "null"], "description": "Assembly instructions or details" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity to assemble (for assembly work orders)" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product to assemble" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user requesting the work order" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "work_order_number": { "type": "string", "description": "Optional work order number - if not provided, will be auto-generated" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse where work will be performed" }, "work_order_line_items": { "items": { "$ref": "#/components/schemas/APIWorkOrderLineItemInput" }, "type": "array", "description": "Line items for the work order" } }, "required": ["type", "warehouse_id"], "type": "object", "additionalProperties": false }, "ShipOSUpdateWorkOrderInput": { "description": "ShipOS-specific update input for work orders.\nSection data is managed through dedicated attachments/components/packages endpoints.", "properties": { "name": { "type": ["string", "null"], "description": "Name of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order" }, "currency": { "type": "string", "description": "Currency for the work order" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order should be completed by" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested" }, "picked_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was picked" }, "assembled_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was assembled" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was completed" }, "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "packing_details": { "type": ["string", "null"], "description": "Packing instructions or details" }, "assembly_details": { "type": ["string", "null"], "description": "Assembly instructions or details" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity to assemble" }, "assembled_quantity": { "type": "number", "format": "double", "description": "Quantity that was assembled" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product to assemble" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user requesting the work order" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor" }, "work_order_line_items": { "items": { "$ref": "#/components/schemas/APIWorkOrderLineItemInput" }, "type": "array", "description": "Line items for the work order" } }, "type": "object", "additionalProperties": false }, "APIWorkOrderPackingUpdateSuccess": { "properties": { "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "pick_list_urls": { "items": { "type": "string" }, "type": "array", "description": "URLs of generated pick list PDFs" }, "work_order_number": { "type": "string", "description": "Human-readable work order number, auto-incremented per fulfiller team" }, "receiving_location_name": { "type": ["string", "null"], "description": "Denormalized: The receiving location name" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "staging_location_name": { "type": ["string", "null"], "description": "Denormalized: The staging location name" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller teams name" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant teams name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team assigned to the work order" }, "vendor_name": { "type": ["string", "null"], "description": "Name of the vendor used for the work order" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor used for the work order" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team that requested the work order" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse assigned to the work order" }, "requested_by_user_name": { "type": ["string", "null"], "description": "Denormalized: The name of the user who requested the work order" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user that requested the work order" }, "assembly_product_image_url": { "type": ["string", "null"], "description": "Denormalized: The assembly product image URL" }, "assembly_product_name": { "type": ["string", "null"], "description": "Denormalized: The assembly product name" }, "assembly_product_sku": { "type": ["string", "null"], "description": "Denormalized: The assembly product SKU" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product being assembled" }, "assembled_quantity": { "type": "number", "format": "double", "description": "Quantity of the product that was assembled" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity of the product to assemble" }, "assembly_details": { "type": ["string", "null"], "description": "Details about the assembly process" }, "packing_details": { "type": ["string", "null"], "description": "Details about the packing process" }, "config": { "$ref": "#/components/schemas/WorkOrderConfig", "description": "Work-order-scoped packing and shipping configuration overrides" }, "currency": { "type": "string", "description": "Currency for the work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "name": { "type": ["string", "null"], "description": "Name of the work order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized name of the user who finalized packing" }, "packed_by_user_id": { "type": ["string", "null"], "description": "User who most recently finalized packing" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was finalized" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was started" }, "packing_revision": { "type": "number", "format": "double", "description": "Monotonic authoritative packing-state revision" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was completed" }, "assembled_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was assembled by the assembler" }, "picked_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was picked" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested by the merchant" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was scheduled to be completed by the fulfiller" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the work order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the work order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "work_order_line_items": { "items": { "$ref": "#/components/schemas/WorkOrderLineItemWithProductStock" }, "type": "array" }, "total_line_items": { "type": "number", "format": "double" }, "total_quantity": { "type": "number", "format": "double" }, "result_type": { "type": "string", "enum": ["success"], "nullable": false } }, "required": [ "description", "pick_list_urls", "work_order_number", "receiving_location_name", "receiving_location_id", "staging_location_name", "staging_location_id", "warehouse_name", "fulfiller_team_name", "merchant_team_name", "fulfiller_team_id", "vendor_name", "vendor_id", "merchant_team_id", "warehouse_id", "requested_by_user_name", "requested_by_user_id", "assembly_product_image_url", "assembly_product_name", "assembly_product_sku", "assembly_product_id", "assembled_quantity", "quantity_to_assemble", "assembly_details", "packing_details", "config", "currency", "priority", "status", "type", "name", "packed_by_user_name", "packed_by_user_id", "packing_completed_at", "packing_started_at", "packing_revision", "completed_at", "assembled_at", "picked_at", "requested_by", "scheduled_by", "updated_at", "created_at", "id", "work_order_line_items", "total_line_items", "total_quantity", "result_type" ], "type": "object", "additionalProperties": false }, "PackingCompletionBlockerCode": { "enum": ["NO_PACKAGES", "UNPACKED_ITEMS", "EMPTY_PACKAGE", "MISSING_SHIPPING_LABEL", "MISSING_PACK_SHOT"], "type": "string" }, "PackingCompletionBlocker": { "description": "One completion blocker contract shared by manual fulfillment, tote packing,\nand work-order packing so all three workflows render and enforce the same result.", "properties": { "code": { "$ref": "#/components/schemas/PackingCompletionBlockerCode" }, "field": { "type": "string" }, "label": { "type": "string" }, "reason": { "type": "string" }, "package_id": { "type": ["string", "null"] }, "package_key": { "type": ["string", "null"] } }, "required": ["code", "field", "label", "reason", "package_id", "package_key"], "type": "object", "additionalProperties": false }, "APIWorkOrderPackingUpdateError": { "properties": { "description": { "type": ["string", "null"], "description": "Detailed description of the work order scope" }, "pick_list_urls": { "items": { "type": "string" }, "type": "array", "description": "URLs of generated pick list PDFs" }, "work_order_number": { "type": "string", "description": "Human-readable work order number, auto-incremented per fulfiller team" }, "receiving_location_name": { "type": ["string", "null"], "description": "Denormalized: The receiving location name" }, "receiving_location_id": { "type": ["string", "null"], "description": "ID of the receiving location" }, "staging_location_name": { "type": ["string", "null"], "description": "Denormalized: The staging location name" }, "staging_location_id": { "type": ["string", "null"], "description": "ID of the staging location" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller teams name" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant teams name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team assigned to the work order" }, "vendor_name": { "type": ["string", "null"], "description": "Name of the vendor used for the work order" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor used for the work order" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team that requested the work order" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse assigned to the work order" }, "requested_by_user_name": { "type": ["string", "null"], "description": "Denormalized: The name of the user who requested the work order" }, "requested_by_user_id": { "type": ["string", "null"], "description": "ID of the user that requested the work order" }, "assembly_product_image_url": { "type": ["string", "null"], "description": "Denormalized: The assembly product image URL" }, "assembly_product_name": { "type": ["string", "null"], "description": "Denormalized: The assembly product name" }, "assembly_product_sku": { "type": ["string", "null"], "description": "Denormalized: The assembly product SKU" }, "assembly_product_id": { "type": ["string", "null"], "description": "ID of the product being assembled" }, "assembled_quantity": { "type": "number", "format": "double", "description": "Quantity of the product that was assembled" }, "quantity_to_assemble": { "type": "number", "format": "double", "description": "Quantity of the product to assemble" }, "assembly_details": { "type": ["string", "null"], "description": "Details about the assembly process" }, "packing_details": { "type": ["string", "null"], "description": "Details about the packing process" }, "config": { "$ref": "#/components/schemas/WorkOrderConfig", "description": "Work-order-scoped packing and shipping configuration overrides" }, "currency": { "type": "string", "description": "Currency for the work order" }, "priority": { "type": "number", "format": "double", "description": "Priority of the work order" }, "status": { "$ref": "#/components/schemas/APIWorkOrderStatus", "description": "Status of the work order" }, "type": { "$ref": "#/components/schemas/APIWorkOrderType", "description": "Type of work order" }, "name": { "type": ["string", "null"], "description": "Name of the work order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized name of the user who finalized packing" }, "packed_by_user_id": { "type": ["string", "null"], "description": "User who most recently finalized packing" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was finalized" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time packing was started" }, "packing_revision": { "type": "number", "format": "double", "description": "Monotonic authoritative packing-state revision" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was completed" }, "assembled_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was assembled by the assembler" }, "picked_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was picked" }, "requested_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was requested by the merchant" }, "scheduled_by": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the work order was scheduled to be completed by the fulfiller" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the work order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the work order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "work_order_line_items": { "items": { "$ref": "#/components/schemas/WorkOrderLineItemWithProductStock" }, "type": "array" }, "total_line_items": { "type": "number", "format": "double" }, "total_quantity": { "type": "number", "format": "double" }, "result_type": { "type": "string", "enum": ["error"], "nullable": false }, "blockers": { "items": { "$ref": "#/components/schemas/PackingCompletionBlocker" }, "type": "array" } }, "required": [ "description", "pick_list_urls", "work_order_number", "receiving_location_name", "receiving_location_id", "staging_location_name", "staging_location_id", "warehouse_name", "fulfiller_team_name", "merchant_team_name", "fulfiller_team_id", "vendor_name", "vendor_id", "merchant_team_id", "warehouse_id", "requested_by_user_name", "requested_by_user_id", "assembly_product_image_url", "assembly_product_name", "assembly_product_sku", "assembly_product_id", "assembled_quantity", "quantity_to_assemble", "assembly_details", "packing_details", "config", "currency", "priority", "status", "type", "name", "packed_by_user_name", "packed_by_user_id", "packing_completed_at", "packing_started_at", "packing_revision", "completed_at", "assembled_at", "picked_at", "requested_by", "scheduled_by", "updated_at", "created_at", "id", "work_order_line_items", "total_line_items", "total_quantity", "result_type", "blockers" ], "type": "object", "additionalProperties": false }, "APIWorkOrderPackingUpdateResult": { "anyOf": [ { "$ref": "#/components/schemas/APIWorkOrderPackingUpdateSuccess" }, { "$ref": "#/components/schemas/APIWorkOrderPackingUpdateError" } ] }, "AuthoritativePackingUnpackedItem": { "properties": { "item_key": { "type": "string" }, "unpacked_quantity": { "type": "number", "format": "double" } }, "required": ["item_key", "unpacked_quantity"], "type": "object", "additionalProperties": false }, "APIPackageConfigInput": { "description": "Public API package-level config input fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "APIWorkOrderPackageLineItemInput": { "properties": { "id": { "type": "string" }, "work_order_line_item_id": { "type": ["string", "null"] }, "product_id": { "type": ["string", "null"] }, "name": { "type": ["string", "null"] }, "sku": { "type": ["string", "null"] }, "image_url": { "type": ["string", "null"] }, "quantity": { "type": "number", "format": "double" }, "lot_code": { "type": ["string", "null"] }, "expiration_date": { "type": ["string", "null"], "format": "date-time" }, "uom_profile_id": { "type": ["string", "null"] }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double" }, "uom_label": { "type": ["string", "null"] }, "weight": { "type": ["number", "null"], "format": "double" }, "weight_unit": { "type": ["string", "null"], "enum": ["G", "KG", "OZ", "LB"] }, "customs_description": { "type": ["string", "null"] }, "customs_value": { "type": ["number", "null"], "format": "double" }, "customs_value_currency": { "type": ["string", "null"] }, "country_of_origin": { "type": ["string", "null"] }, "hs_code": { "type": ["string", "null"] }, "manufacturer": { "type": ["string", "null"] }, "eccn": { "type": ["string", "null"] }, "printed_commodity_identifier": { "type": ["string", "null"] } }, "required": ["quantity"], "type": "object", "additionalProperties": false }, "APIUpdateWorkOrderPackageInput": { "properties": { "id": { "type": ["string", "null"] }, "idempotency_key": { "type": ["string", "null"] }, "key": { "type": "string" }, "name": { "type": "string" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit" }, "weight": { "type": "number", "format": "double" }, "total_customs_value": { "type": ["number", "null"], "format": "double" }, "config": { "oneOf": [ { "$ref": "#/components/schemas/APIPackageConfigInput" }, { "type": "null" } ] }, "to_address_name": { "type": ["string", "null"] }, "to_address_company": { "type": ["string", "null"] }, "to_address_address1": { "type": ["string", "null"] }, "to_address_address2": { "type": ["string", "null"] }, "to_address_city": { "type": ["string", "null"] }, "to_address_state": { "type": ["string", "null"] }, "to_address_country": { "type": ["string", "null"] }, "to_address_zip": { "type": ["string", "null"] }, "to_address_phone": { "type": ["string", "null"] }, "to_address_email": { "type": ["string", "null"] }, "carrier_integration_id": { "type": ["string", "null"] }, "carrier_id": { "type": ["string", "null"] }, "service_id": { "type": ["string", "null"] }, "provider_rate_id": { "type": ["string", "null"] }, "rate_shop_id": { "type": ["string", "null"] }, "rate_shop_name": { "type": ["string", "null"] }, "carton_id": { "type": ["string", "null"] }, "package_line_items": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/APIWorkOrderPackageLineItemInput" } } }, "type": "object", "additionalProperties": false }, "APIUpdateWorkOrderPackagesInput": { "description": "Complete desired package state; persisted IDs update, omitted IDs create, and omitted rows delete.", "properties": { "protocol_version": { "type": "number", "enum": [1], "nullable": false }, "base_revision": { "type": "number", "format": "double" }, "base_package_keys": { "items": { "type": "string" }, "type": "array" }, "unpacked_items": { "items": { "$ref": "#/components/schemas/AuthoritativePackingUnpackedItem" }, "type": "array" }, "override_pin": { "type": "string" }, "finalize": { "type": "boolean" }, "packages": { "items": { "$ref": "#/components/schemas/APIUpdateWorkOrderPackageInput" }, "type": "array" } }, "required": ["packages"], "type": "object", "additionalProperties": false }, "WarehouseSupportedActionType": { "enum": ["VIEW_WAREHOUSE", "UPDATE_WAREHOUSE", "DELETE_WAREHOUSE", "MAKE_DEFAULT"], "type": "string" }, "APISupportedAction_WarehouseSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/WarehouseSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "WarehouseSupportedAction": { "$ref": "#/components/schemas/APISupportedAction_WarehouseSupportedActionType_" }, "LaborBillingRoundingMode": { "enum": ["UP", "DOWN", "NEAREST"], "type": "string" }, "PickingSessionOrderSortStrategy": { "type": "string", "enum": ["PRIORITY_THEN_FIFO", "SLA_FIRST", "PRIORITY_THEN_SLA", "FIFO_ONLY"] }, "PickingSessionLineItemSort": { "type": "string", "enum": ["LOCATION", "PRODUCT_SKU"] }, "BatchOptimizationType": { "type": "string", "enum": ["NONE", "LOCATION", "LOCATION_PREFIX", "FULFILL_BY_PRIORITY"] }, "APIWarehouseConfig": { "description": "Public API warehouse-level config response fields.", "properties": { "auto_pause_inactive_jobs": { "type": ["boolean", "null"] }, "auto_pause_inactivity_minutes": { "type": ["number", "null"], "format": "double" }, "auto_track_picking": { "type": ["boolean", "null"] }, "auto_track_packing": { "type": ["boolean", "null"] }, "auto_track_receiving": { "type": ["boolean", "null"] }, "auto_track_cycle_counting": { "type": ["boolean", "null"] }, "auto_track_put_away": { "type": ["boolean", "null"] }, "auto_track_replenishment": { "type": ["boolean", "null"] }, "labor_billing_auto_create_work_order_charges": { "type": ["boolean", "null"] }, "labor_billing_auto_create_purchase_order_charges": { "type": ["boolean", "null"] }, "labor_billing_rounding_minutes": { "type": ["number", "null"], "format": "double" }, "labor_billing_rounding_mode": { "type": ["string", "null"], "enum": ["UP", "DOWN", "NEAREST"] }, "live_board_end_of_day_hour": { "type": ["number", "null"], "format": "double" }, "interruption_threshold_minutes": { "type": ["number", "null"], "format": "double" }, "default_picking_benchmark_seconds": { "type": ["number", "null"], "format": "double" }, "labor_hourly_board_start_hour": { "type": ["number", "null"], "format": "double" }, "labor_hourly_board_end_hour": { "type": ["number", "null"], "format": "double" }, "productivity_excellent_threshold": { "type": ["number", "null"], "format": "double" }, "productivity_good_threshold": { "type": ["number", "null"], "format": "double" }, "performance_readiness_min_samples_required": { "type": ["number", "null"], "format": "double" }, "performance_readiness_min_samples_per_bracket": { "type": ["number", "null"], "format": "double" }, "scheduled_baseline_lookback_days": { "type": ["number", "null"], "format": "double" }, "scheduled_baseline_min_sample_count": { "type": ["number", "null"], "format": "double" }, "scheduled_baseline_max_duration_seconds": { "type": ["number", "null"], "format": "double" }, "performance_score_excellent_threshold": { "type": ["number", "null"], "format": "double" }, "performance_score_good_threshold": { "type": ["number", "null"], "format": "double" }, "performance_score_average_threshold": { "type": ["number", "null"], "format": "double" }, "performance_score_below_average_threshold": { "type": ["number", "null"], "format": "double" }, "picking_session_order_sort_strategy": { "type": ["string", "null"], "enum": ["PRIORITY_THEN_FIFO", "SLA_FIRST", "PRIORITY_THEN_SLA", "FIFO_ONLY"] }, "picking_session_line_item_sort": { "type": ["string", "null"], "enum": ["LOCATION", "PRODUCT_SKU"] }, "picking_session_fefo_override": { "type": ["boolean", "null"] }, "picking_session_batch_optimization_type": { "type": ["string", "null"], "enum": ["NONE", "LOCATION", "LOCATION_PREFIX", "FULFILL_BY_PRIORITY"] }, "picking_session_exclude_single_sku_from_mib": { "type": ["boolean", "null"] }, "picking_session_required_ship_date_filter": { "type": ["boolean", "null"] }, "break_alert_minutes": { "type": ["number", "null"], "format": "double" }, "lunch_alert_minutes": { "type": ["number", "null"], "format": "double" }, "no_job_alert_minutes": { "type": ["number", "null"], "format": "double" }, "picking_idle_threshold_minutes": { "type": ["number", "null"], "format": "double" }, "labor_no_show_alerts_enabled": { "type": ["boolean", "null"] }, "break_compliance_enabled": { "type": ["boolean", "null"] }, "meal_break_required_after_hours": { "type": ["number", "null"], "format": "double" }, "meal_break_minimum_minutes": { "type": ["number", "null"], "format": "double" }, "rest_break_tracking_enabled": { "type": ["boolean", "null"] }, "rest_break_required_after_hours": { "type": ["number", "null"], "format": "double" }, "rest_break_minimum_minutes": { "type": ["number", "null"], "format": "double" }, "break_min_interval_seconds": { "type": ["number", "null"], "format": "double" }, "break_min_duration_seconds": { "type": ["number", "null"], "format": "double" }, "break_max_duration_seconds": { "type": ["number", "null"], "format": "double" }, "no_show_threshold_minutes": { "type": ["number", "null"], "format": "double" }, "late_threshold_minutes": { "type": ["number", "null"], "format": "double" }, "early_threshold_minutes": { "type": ["number", "null"], "format": "double" }, "override_pin": { "type": ["string", "null"] }, "replenishment_minimum_level": { "type": ["number", "null"], "format": "double" }, "replenishment_maximum_level": { "type": ["number", "null"], "format": "double" }, "replenishment_increment_level": { "type": ["number", "null"], "format": "double" }, "replenishment_source_strategy": { "type": ["string", "null"], "enum": ["FIFO", "FEFO", null] } }, "type": "object", "additionalProperties": false }, "APIExpandedWarehouseWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "config": { "description": "Per-warehouse config overrides (Labor fields). Null fields inherit from team config or global defaults.", "oneOf": [ { "$ref": "#/components/schemas/APIWarehouseConfig" }, { "type": "null" } ] }, "team_name": { "type": "string", "description": "Name of the team (denormalized)" }, "team_id": { "type": "string", "description": "ID of the team that owns this warehouse" }, "default": { "type": "boolean", "description": "Whether this is the default warehouse for the team" }, "timezone": { "type": "string", "description": "Timezone identifier (e.g., \"America/Los_Angeles\")" }, "longitude": { "type": ["number", "null"], "format": "double", "description": "Longitude coordinate" }, "latitude": { "type": ["number", "null"], "format": "double", "description": "Latitude coordinate" }, "email": { "type": ["string", "null"], "description": "Contact email address (used as from_address_email on shipping labels)" }, "phone": { "type": ["string", "null"], "description": "Contact phone number" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2)" }, "state": { "type": "string", "description": "State or province" }, "zip": { "type": "string", "description": "ZIP or postal code" }, "city": { "type": "string", "description": "City" }, "address2": { "type": ["string", "null"], "description": "Secondary address line" }, "address1": { "type": "string", "description": "Primary address line" }, "company": { "type": "string", "description": "Company name" }, "name": { "type": "string", "description": "Name of the warehouse" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the warehouse was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the warehouse was created" }, "id": { "type": "string", "description": "Unique identifier for the warehouse" }, "supported_actions": { "items": { "$ref": "#/components/schemas/WarehouseSupportedAction" }, "type": "array", "description": "List of supported actions for this warehouse" } }, "required": [ "config", "team_name", "team_id", "default", "timezone", "longitude", "latitude", "email", "phone", "country", "state", "zip", "city", "address2", "address1", "company", "name", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedWarehouse": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "config": { "description": "Per-warehouse config overrides (Labor fields). Null fields inherit from team config or global defaults.", "oneOf": [ { "$ref": "#/components/schemas/APIWarehouseConfig" }, { "type": "null" } ] }, "team_name": { "type": "string", "description": "Name of the team (denormalized)" }, "team_id": { "type": "string", "description": "ID of the team that owns this warehouse" }, "default": { "type": "boolean", "description": "Whether this is the default warehouse for the team" }, "timezone": { "type": "string", "description": "Timezone identifier (e.g., \"America/Los_Angeles\")" }, "longitude": { "type": ["number", "null"], "format": "double", "description": "Longitude coordinate" }, "latitude": { "type": ["number", "null"], "format": "double", "description": "Latitude coordinate" }, "email": { "type": ["string", "null"], "description": "Contact email address (used as from_address_email on shipping labels)" }, "phone": { "type": ["string", "null"], "description": "Contact phone number" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2)" }, "state": { "type": "string", "description": "State or province" }, "zip": { "type": "string", "description": "ZIP or postal code" }, "city": { "type": "string", "description": "City" }, "address2": { "type": ["string", "null"], "description": "Secondary address line" }, "address1": { "type": "string", "description": "Primary address line" }, "company": { "type": "string", "description": "Company name" }, "name": { "type": "string", "description": "Name of the warehouse" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the warehouse was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the warehouse was created" }, "id": { "type": "string", "description": "Unique identifier for the warehouse" } }, "required": [ "config", "team_name", "team_id", "default", "timezone", "longitude", "latitude", "email", "phone", "country", "state", "zip", "city", "address2", "address1", "company", "name", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "APICreateWarehouseInput": { "description": "Input for creating a new warehouse", "properties": { "name": { "type": "string", "description": "Name of the warehouse" }, "company": { "type": "string", "description": "Company name" }, "address1": { "type": "string", "description": "Primary address line" }, "address2": { "type": ["string", "null"], "description": "Secondary address line" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province" }, "zip": { "type": "string", "description": "ZIP or postal code" }, "country": { "type": "string", "description": "Country code (2-letter ISO)" }, "phone": { "type": "string", "description": "Contact phone number" }, "latitude": { "type": ["number", "null"], "format": "double", "description": "Latitude coordinate" }, "longitude": { "type": ["number", "null"], "format": "double", "description": "Longitude coordinate" }, "timezone": { "type": "string", "description": "Timezone identifier (e.g., \"America/Los_Angeles\")" } }, "required": ["name", "company", "address1", "city", "state", "zip", "country", "phone", "timezone"], "type": "object", "additionalProperties": false }, "APIUpdateWarehouseInput": { "description": "Input for updating a warehouse - all fields are optional for partial updates", "properties": { "name": { "type": "string", "description": "Name of the warehouse" }, "company": { "type": "string", "description": "Company name" }, "address1": { "type": "string", "description": "Primary address line" }, "address2": { "type": ["string", "null"], "description": "Secondary address line" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province" }, "zip": { "type": "string", "description": "ZIP or postal code" }, "country": { "type": "string", "description": "Country code (2-letter ISO)" }, "phone": { "type": "string", "description": "Contact phone number" }, "latitude": { "type": ["number", "null"], "format": "double", "description": "Latitude coordinate" }, "longitude": { "type": ["number", "null"], "format": "double", "description": "Longitude coordinate" }, "timezone": { "type": "string", "description": "Timezone identifier (e.g., \"America/Los_Angeles\")" } }, "type": "object", "additionalProperties": false }, "APIMinimalWarehouseWithActions": { "description": "API Warehouse with minimal data and supported actions for public API", "properties": { "config": { "description": "Per-warehouse config overrides (Labor fields). Null fields inherit from team config or global defaults.", "oneOf": [ { "$ref": "#/components/schemas/APIWarehouseConfig" }, { "type": "null" } ] }, "team_name": { "type": "string", "description": "Name of the team (denormalized)" }, "team_id": { "type": "string", "description": "ID of the team that owns this warehouse" }, "default": { "type": "boolean", "description": "Whether this is the default warehouse for the team" }, "timezone": { "type": "string", "description": "Timezone identifier (e.g., \"America/Los_Angeles\")" }, "longitude": { "type": ["number", "null"], "format": "double", "description": "Longitude coordinate" }, "latitude": { "type": ["number", "null"], "format": "double", "description": "Latitude coordinate" }, "email": { "type": ["string", "null"], "description": "Contact email address (used as from_address_email on shipping labels)" }, "phone": { "type": ["string", "null"], "description": "Contact phone number" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2)" }, "state": { "type": "string", "description": "State or province" }, "zip": { "type": "string", "description": "ZIP or postal code" }, "city": { "type": "string", "description": "City" }, "address2": { "type": ["string", "null"], "description": "Secondary address line" }, "address1": { "type": "string", "description": "Primary address line" }, "company": { "type": "string", "description": "Company name" }, "name": { "type": "string", "description": "Name of the warehouse" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the warehouse was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the warehouse was created" }, "id": { "type": "string", "description": "Unique identifier for the warehouse" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_WarehouseSupportedActionType_" }, "type": "array", "description": "Supported actions for this warehouse" } }, "required": [ "config", "team_name", "team_id", "default", "timezone", "longitude", "latitude", "email", "phone", "country", "state", "zip", "city", "address2", "address1", "company", "name", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalWarehouseWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalWarehouseWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyWarehousesResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalWarehouseWithActions_", "description": "Response type for get-many operations" }, "APILocationLocationKind": { "type": "string", "enum": ["STATIC", "LPN", "TOTE"], "description": "API-compatible type unions that mirror Prisma enums for TSOA compatibility.\nThese type unions are used in API schemas and responses to avoid direct Prisma enum dependencies.\n\nWe still use prisma generated enums for anytime we need the true enum or z.enum(Enum) for parsing. But otherwise pass these for TSOA" }, "APIBaseLocation": { "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id" ], "type": "object" }, "APIPickingSessionFulfillmentOrderStatus": { "type": "string", "enum": ["PENDING", "FULFILLED"] }, "APIBasePickingSessionFulfillmentOrder": { "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time the picking session fulfillment order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session fulfillment order was last updated" }, "status": { "$ref": "#/components/schemas/APIPickingSessionFulfillmentOrderStatus", "description": "Status of the picking session fulfillment order" }, "fulfillment_order_id": { "type": "string", "description": "ID of the fulfillment order" }, "tote_id": { "type": ["string", "null"], "description": "ID of the tote" }, "tote_name": { "type": ["string", "null"], "description": "Name of the tote (denormalized for historical accuracy)" }, "picking_session_id": { "type": "string", "description": "ID of the picking session" }, "order_number": { "type": "string", "description": "Order number" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "When packing started (tote was scanned)" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When packing completed (order was fulfilled)" }, "packed_by_user_id": { "type": ["string", "null"], "description": "ID of the user who packed this order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who packed this order" } }, "required": [ "created_at", "updated_at", "status", "fulfillment_order_id", "tote_id", "tote_name", "picking_session_id", "order_number", "packing_started_at", "packing_completed_at", "packed_by_user_id", "packed_by_user_name" ], "type": "object", "additionalProperties": false }, "APIMinimalTote": { "description": "API Tote for list views (getMany) where product_stock is lazy loaded.\nUse APIExpandedTote when you need product_stock included.", "properties": { "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity in this tote - maintained by database trigger" }, "is_empty": { "type": "boolean", "description": "Whether the tote is empty (no product stock) - maintained by database trigger" }, "barcode": { "type": "string", "description": "Barcode for scanning" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the tote was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the tote was created" }, "location_type_id": { "type": ["string", "null"], "description": "Location type ID" }, "parent_location_name": { "type": ["string", "null"], "description": "Denormalized: Parent location name" }, "parent_location_id": { "type": ["string", "null"], "description": "Parent location ID" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Type of location (always TOTE)" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this tote belongs to" }, "name": { "type": "string", "description": "Name of the tote" }, "team_id": { "type": "string", "description": "ID of team that owns this tote" }, "id": { "type": "string", "description": "Unique identifier for the tote" }, "parent_location": { "description": "Parent location", "oneOf": [ { "$ref": "#/components/schemas/APIBaseLocation" }, { "type": "null" } ] }, "picking_session_fulfillment_orders": { "items": { "$ref": "#/components/schemas/APIBasePickingSessionFulfillmentOrder" }, "type": "array", "description": "Picking session fulfillment orders" } }, "required": [ "on_hand", "is_empty", "barcode", "updated_at", "created_at", "location_type_id", "parent_location_name", "parent_location_id", "location_kind", "warehouse_id", "name", "team_id", "id", "parent_location", "picking_session_fulfillment_orders" ], "type": "object", "additionalProperties": false }, "CreateToteInput": { "description": "Subset of the Tote resource that is used for creating a new tote", "properties": { "name": { "type": "string", "description": "Name of the tote" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse to create this tote in" } }, "required": ["name", "warehouse_id"], "type": "object", "additionalProperties": false }, "UpdateToteInput": { "description": "For updating a tote - all fields are optional for partial updates\nNote: warehouse_id is immutable after creation and cannot be updated", "properties": { "name": { "type": "string", "description": "Name of the tote" } }, "type": "object", "additionalProperties": false }, "MoveToteInput": { "description": "Input for moving a tote to a new parent location", "properties": { "parent_location_id": { "type": ["string", "null"], "description": "ID of the new parent location *(null to remove the parent)*" } }, "required": ["parent_location_id"], "type": "object", "additionalProperties": false }, "LocationSupportedActionType": { "enum": [ "VIEW_TOTE", "VIEW_LOCATION", "VIEW_PARENT_LOCATION", "VIEW_INVENTORY_HISTORY", "UPDATE_LOCATION", "UPDATE_TOTE", "MOVE_LOCATION", "MOVE_TOTE", "DELETE_LOCATION", "DELETE_TOTE", "GENERATE_LABEL", "GENERATE_LPN", "STOCK_PRODUCT", "EMPTY_TOTE", "REMOVE_FROM_PARENT", "PACK_TOTE", "REMOVE_FLAG", "ADD_FLAG" ], "type": "string" }, "APISupportedAction_LocationSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/LocationSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIMinimalToteWithActions": { "description": "API Tote for list views with supported actions.\nProduct stock is NOT included - load it via getChildren for lazy loading.", "properties": { "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity in this tote - maintained by database trigger" }, "is_empty": { "type": "boolean", "description": "Whether the tote is empty (no product stock) - maintained by database trigger" }, "barcode": { "type": "string", "description": "Barcode for scanning" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the tote was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the tote was created" }, "location_type_id": { "type": ["string", "null"], "description": "Location type ID" }, "parent_location_name": { "type": ["string", "null"], "description": "Denormalized: Parent location name" }, "parent_location_id": { "type": ["string", "null"], "description": "Parent location ID" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Type of location (always TOTE)" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this tote belongs to" }, "name": { "type": "string", "description": "Name of the tote" }, "team_id": { "type": "string", "description": "ID of team that owns this tote" }, "id": { "type": "string", "description": "Unique identifier for the tote" }, "parent_location": { "description": "Parent location", "oneOf": [ { "$ref": "#/components/schemas/APIBaseLocation" }, { "type": "null" } ] }, "picking_session_fulfillment_orders": { "items": { "$ref": "#/components/schemas/APIBasePickingSessionFulfillmentOrder" }, "type": "array", "description": "Picking session fulfillment orders" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_LocationSupportedActionType_" }, "type": "array", "description": "Supported actions for this tote" } }, "required": [ "on_hand", "is_empty", "barcode", "updated_at", "created_at", "location_type_id", "parent_location_name", "parent_location_id", "location_kind", "warehouse_id", "name", "team_id", "id", "parent_location", "picking_session_fulfillment_orders", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalToteWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalToteWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyTotesResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalToteWithActions_", "description": "Response for getting multiple totes.\nNote: product_stock is NOT included - it's lazy loaded via getChildren endpoint." }, "ShopSupportedActionType": { "enum": [ "DELETE_SHOP", "ENABLE_INVENTORY_SYNC", "DISABLE_INVENTORY_SYNC", "SET_ORDER_CUTOFF_DATE", "SYNC_ALL_RESOURCES", "SYNC_PRODUCTS", "SYNC_ORDERS", "SYNC_INVENTORY", "SYNC_WEBHOOKS", "SYNC_DRAFT_ORDERS", "SYNC_FULFILLMENT_ORDERS", "SYNC_ALL_FULFILLMENT_ORDERS", "SYNC_FULFILLMENT_SERVICES", "SYNC_LOCATIONS", "SYNC_ALL_PRODUCTS", "SYNC_RECENT_PRODUCTS", "SYNC_ALL_ORDERS", "SYNC_RECENT_ORDERS", "SYNC_RETURNS", "SYNC_CANCELLATIONS" ], "type": "string" }, "APISupportedAction_ShopSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ShopSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIShopType": { "type": "string", "enum": ["SHOPIFY", "MAGENTO2", "BIGCOMMERCE", "MANUAL", "WOOCOMMERCE", "WIX", "TIKTOK"] }, "APIExpandedShopWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "authorization_expires_at": { "type": ["string", "null"], "format": "date-time", "description": "Upcoming seller authorization expiry reported by TikTok, when known" }, "order_sync_start_date": { "type": ["string", "null"], "format": "date-time", "description": "Order sync start date (cutoff date)" }, "inventory_sync_enabled": { "type": "boolean", "description": "Whether inventory sync is enabled" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was synced" }, "remote_slug": { "type": ["string", "null"], "description": "Remote slug of the shop" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID of the shop" }, "uninstalled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was uninstalled" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the shop was created" }, "slug": { "type": ["string", "null"], "description": "Shop slug" }, "country": { "type": ["string", "null"], "description": "Shop country" }, "domain": { "type": ["string", "null"], "description": "Shop domain" }, "currency": { "type": "string", "description": "Shop currency" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team for this shop" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this shop" }, "type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "name": { "type": "string", "description": "Shop name" }, "id": { "type": "string", "description": "Unique identifier for the shop" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ShopSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "authorization_expires_at", "order_sync_start_date", "inventory_sync_enabled", "synced_at", "remote_slug", "remote_id", "uninstalled_at", "updated_at", "created_at", "slug", "country", "domain", "currency", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "type", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIMinimalShopWithActions": { "properties": { "authorization_expires_at": { "type": ["string", "null"], "format": "date-time", "description": "Upcoming seller authorization expiry reported by TikTok, when known" }, "order_sync_start_date": { "type": ["string", "null"], "format": "date-time", "description": "Order sync start date (cutoff date)" }, "inventory_sync_enabled": { "type": "boolean", "description": "Whether inventory sync is enabled" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was synced" }, "remote_slug": { "type": ["string", "null"], "description": "Remote slug of the shop" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID of the shop" }, "uninstalled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was uninstalled" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the shop was created" }, "slug": { "type": ["string", "null"], "description": "Shop slug" }, "country": { "type": ["string", "null"], "description": "Shop country" }, "domain": { "type": ["string", "null"], "description": "Shop domain" }, "currency": { "type": "string", "description": "Shop currency" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team for this shop" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this shop" }, "type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "name": { "type": "string", "description": "Shop name" }, "id": { "type": "string", "description": "Unique identifier for the shop" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ShopSupportedActionType_" }, "type": "array" } }, "required": [ "authorization_expires_at", "order_sync_start_date", "inventory_sync_enabled", "synced_at", "remote_slug", "remote_id", "uninstalled_at", "updated_at", "created_at", "slug", "country", "domain", "currency", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "type", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIGetManyShopsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalShopWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIShippingLabelScanStatus": { "type": "string", "enum": ["SCANNED", "PENDING"] }, "APIShippingLabelRefundStatus": { "type": "string", "enum": ["SUBMITTED", "REJECTED", "REFUNDED"] }, "CarrierCorrectionProvider": { "type": "string", "enum": ["EASYPOST", "UPS"] }, "CarrierCorrectionFormat": { "type": "string", "enum": ["UPS_INVOICE_SUMMARY_V1", "EASYPOST_ADJUSTMENTS_V1"] }, "Currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ] }, "ShippingLabelCarrierCorrection": { "properties": { "version": { "type": "number", "enum": [1], "nullable": false }, "source_import": { "properties": { "filename": { "type": "string" }, "import_id": { "type": "string" } }, "required": ["filename", "import_id"], "type": "object" }, "provider": { "$ref": "#/components/schemas/CarrierCorrectionProvider" }, "format": { "$ref": "#/components/schemas/CarrierCorrectionFormat" }, "carrier_invoice_number": { "type": "string" }, "carrier_invoice_date": { "type": ["string", "null"] }, "transaction_date": { "type": ["string", "null"] }, "confirmed_at": { "type": "string" }, "tracking_number": { "type": "string" }, "correction_type": { "type": ["string", "null"] }, "correction_reason": { "type": ["string", "null"] }, "carrier_service_code": { "type": ["string", "null"] }, "published_amount": { "type": ["number", "null"], "format": "double" }, "incentive_amount": { "type": ["number", "null"], "format": "double" }, "original_carrier_cost": { "type": ["number", "null"], "format": "double" }, "carrier_adjustment_amount": { "type": "number", "format": "double" }, "corrected_carrier_cost": { "type": ["number", "null"], "format": "double" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "version", "source_import", "provider", "format", "carrier_invoice_number", "carrier_invoice_date", "transaction_date", "confirmed_at", "tracking_number", "correction_type", "correction_reason", "carrier_service_code", "published_amount", "incentive_amount", "original_carrier_cost", "carrier_adjustment_amount", "corrected_carrier_cost", "currency" ], "type": "object", "additionalProperties": false }, "APIBaseShippingLabel": { "properties": { "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string" }, "tracking_url": { "type": ["string", "null"], "description": "Tracking URL" }, "carrier_correction": { "description": "Latest confirmed carrier correction snapshot, when the label has been corrected", "oneOf": [ { "$ref": "#/components/schemas/ShippingLabelCarrierCorrection" }, { "type": "null" } ] }, "gaylord_id": { "type": ["string", "null"], "description": "Gaylord ID" }, "carrier_account_id": { "type": ["string", "null"], "description": "Carrier account ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "shipment_status": { "$ref": "#/components/schemas/APIShippingLabelShipmentStatus", "description": "Shipment status" }, "refund_status": { "description": "Refund status", "type": ["string", "null"], "enum": ["SUBMITTED", "REJECTED", "REFUNDED"] }, "scan_status": { "$ref": "#/components/schemas/APIShippingLabelScanStatus", "description": "Scan status" }, "label_with_packing_slip_url": { "type": ["string", "null"], "description": "Label with packing slip URL" }, "original_label_url": { "type": ["string", "null"], "description": "Original label URL" }, "label_url": { "type": ["string", "null"], "description": "Label URL" }, "tracking_code": { "type": ["string", "null"], "description": "Tracking code" }, "zone": { "type": ["number", "null"], "format": "double", "description": "Carrier zone" }, "delivery_date_guaranteed": { "type": ["boolean", "null"], "description": "Delivery date guaranteed" }, "delivery_date": { "type": ["string", "null"], "format": "date-time", "description": "Delivery date" }, "delivery_days": { "type": ["string", "null"], "description": "Delivery days" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address zip" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_street2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_street1": { "type": ["string", "null"], "description": "To address street 1" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address zip" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_street2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_street1": { "type": ["string", "null"], "description": "From address street 1" }, "list_currency": { "type": ["string", "null"], "description": "List currency" }, "list_rate": { "type": ["number", "null"], "format": "double", "description": "List rate" }, "retail_currency": { "type": ["string", "null"], "description": "Retail currency" }, "retail_price": { "type": ["number", "null"], "format": "double", "description": "Retail price" }, "currency": { "type": "string", "description": "Currency" }, "price": { "type": "number", "format": "double", "description": "Price" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "remote_bukuship_shipment_id": { "type": ["string", "null"], "description": "Remote Bukuship shipment ID" }, "remote_easypost_tracker_id": { "type": ["string", "null"], "description": "Remote EasyPost tracker ID" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID" }, "voided_at": { "type": ["string", "null"], "format": "date-time", "description": "When the label was voided" }, "shipping_label_number": { "type": "string", "description": "Human-readable shipping label number" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the label was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the label was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "formatted_service", "tracking_url", "carrier_correction", "gaylord_id", "carrier_account_id", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "carrier_integration_type", "carrier_integration_name", "carrier_integration_id", "shipment_status", "refund_status", "scan_status", "label_with_packing_slip_url", "original_label_url", "label_url", "tracking_code", "zone", "delivery_date_guaranteed", "delivery_date", "delivery_days", "to_address_name", "to_address_company", "to_address_phone", "to_address_country", "to_address_zip", "to_address_state", "to_address_city", "to_address_street2", "to_address_street1", "from_address_name", "from_address_company", "from_address_phone", "from_address_country", "from_address_zip", "from_address_state", "from_address_city", "from_address_street2", "from_address_street1", "list_currency", "list_rate", "retail_currency", "retail_price", "currency", "price", "carrier_id", "service_id", "remote_bukuship_shipment_id", "remote_easypost_tracker_id", "remote_id", "voided_at", "shipping_label_number", "updated_at", "created_at", "id" ], "type": "object" }, "APIMinimalShippingLabel": { "$ref": "#/components/schemas/APIBaseShippingLabel", "description": "API type for list and CUD operations (without supported actions)" }, "PaginatedResponse_APIMinimalShippingLabel_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalShippingLabel" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyShippingLabelsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalShippingLabel_", "description": "Response type for get-many operations (no supported_actions in list view)" }, "RateSelectionMode": { "enum": ["RATE_SHOP", "CHEAPEST_FALLBACK", "FIXED_SERVICE"], "type": "string" }, "RateSelectionReason": { "enum": [ "CHEAPEST_ELIGIBLE", "PREFERRED_WITHIN_THRESHOLD", "CHEAPEST_MATCHING_FILTERS", "CHEAPEST_AVAILABLE", "PRESELECTED_SERVICE" ], "type": "string" }, "RateShopPreferenceThresholdType": { "type": "string", "enum": ["CURRENCY", "PERCENTAGE"] }, "ShippingLabelEvaluatedRate": { "properties": { "provider_rate_id": { "type": "string" }, "delivery_date": { "type": ["string", "null"] }, "delivery_date_guaranteed": { "type": "boolean" }, "currency": { "type": "string" }, "label": { "type": "string" }, "carrier_integration_id": { "type": ["string", "null"] }, "carrier_integration_type": { "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_id": { "type": ["string", "null"] }, "service_id": { "type": ["string", "null"] }, "amount": { "type": ["number", "null"], "format": "double" }, "zone": { "type": ["number", "null"], "format": "double" }, "estimated_days": { "type": ["number", "null"], "format": "double" }, "eligible": { "type": "boolean" }, "selected": { "type": "boolean" }, "reasons": { "items": { "type": "string" }, "type": "array" } }, "required": [ "label", "carrier_integration_id", "carrier_integration_type", "carrier_id", "service_id", "amount", "zone", "estimated_days", "eligible", "selected", "reasons" ], "type": "object", "additionalProperties": false }, "RateSelectionStepKey": { "enum": [ "FETCHED_RATES", "FILTERED_TO_CONFIGURED_SERVICES", "FILTERED_TO_DELIVERY_REQUIREMENTS", "MATCHED_REQUESTED_FILTERS", "APPLIED_PREFERENCE_RULE", "USED_PRESELECTED_SERVICE", "SELECTED_RATE" ], "type": "string" }, "ShippingLabelRateSelectionStep": { "properties": { "key": { "$ref": "#/components/schemas/RateSelectionStepKey" }, "detail": { "type": "string" } }, "required": ["key", "detail"], "type": "object", "additionalProperties": false }, "ShippingLabelConfiguredService": { "properties": { "carrier_integration_id": { "type": "string" }, "carrier_integration_name": { "type": ["string", "null"] }, "carrier_integration_type": { "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_id": { "type": "string" }, "service_id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "carrier_id", "service_id", "label" ], "type": "object", "additionalProperties": false }, "ShippingLabelConfiguredServiceLevels": { "properties": { "domestic": { "items": { "$ref": "#/components/schemas/ShippingLabelConfiguredService" }, "type": "array" }, "international": { "items": { "$ref": "#/components/schemas/ShippingLabelConfiguredService" }, "type": "array" } }, "required": ["domestic", "international"], "type": "object", "additionalProperties": false }, "ShippingLabelIntegrationRateSummary": { "properties": { "carrier_integration_id": { "type": "string" }, "carrier_integration_name": { "type": "string" }, "carrier_integration_type": { "$ref": "#/components/schemas/APICarrierType" }, "available_rate_count": { "type": "number", "format": "double" } }, "required": [ "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "available_rate_count" ], "type": "object", "additionalProperties": false }, "ShippingLabelRateFetchIssue": { "properties": { "carrier_integration_id": { "type": "string" }, "carrier_integration_name": { "type": "string" }, "carrier_integration_type": { "$ref": "#/components/schemas/APICarrierType" }, "message": { "type": "string" } }, "required": ["carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "message"], "type": "object", "additionalProperties": false }, "RateFetchDecision": { "enum": ["FETCHED", "SKIPPED"], "type": "string" }, "RateFetchDecisionReason": { "enum": [ "ELIGIBLE_CONFIGURED_SERVICES", "UNRESTRICTED_FETCH", "SHIPMENT_TYPE_NOT_APPLICABLE", "PACKAGE_POLICY_EXCLUDED", "INTEGRATION_UNAVAILABLE", "INTEGRATION_DISABLED", "NO_ENABLED_CONFIGURED_SERVICES" ], "type": "string" }, "RateFetchShipmentType": { "enum": ["DOMESTIC", "INTERNATIONAL"], "type": "string" }, "RateFetchServiceLevelDecisionReason": { "enum": [ "ELIGIBLE_CONFIGURED_SERVICE", "SHIPMENT_TYPE_NOT_APPLICABLE", "PACKAGE_POLICY_EXCLUDED", "INTEGRATION_UNAVAILABLE", "INTEGRATION_DISABLED", "CARRIER_DISABLED", "SERVICE_DISABLED" ], "type": "string" }, "ShippingLabelRateFetchServiceLevelDecision": { "properties": { "carrier_id": { "type": "string" }, "service_id": { "type": "string" }, "shipment_type": { "$ref": "#/components/schemas/RateFetchShipmentType" }, "decision": { "$ref": "#/components/schemas/RateFetchDecision" }, "reason": { "$ref": "#/components/schemas/RateFetchServiceLevelDecisionReason" } }, "required": ["carrier_id", "service_id", "shipment_type", "decision", "reason"], "type": "object", "additionalProperties": false }, "ShippingLabelRateFetchDecision": { "properties": { "carrier_integration_id": { "type": "string" }, "carrier_integration_name": { "type": ["string", "null"] }, "carrier_integration_type": { "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "decision": { "$ref": "#/components/schemas/RateFetchDecision" }, "reason": { "$ref": "#/components/schemas/RateFetchDecisionReason" }, "provider_called": { "type": "boolean" }, "returned_rate_count": { "type": "number", "format": "double" }, "retained_rate_count": { "type": "number", "format": "double" }, "service_levels": { "items": { "$ref": "#/components/schemas/ShippingLabelRateFetchServiceLevelDecision" }, "type": "array" } }, "required": [ "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "decision", "reason", "provider_called", "returned_rate_count", "retained_rate_count", "service_levels" ], "type": "object", "additionalProperties": false }, "ShippingLabelRateSelectionDetails": { "properties": { "version": { "type": "number", "enum": [1], "nullable": false }, "mode": { "$ref": "#/components/schemas/RateSelectionMode" }, "summary": { "type": "string" }, "selection_timestamp": { "type": ["string", "null"] }, "selected_because": { "type": ["string", "null"], "enum": [ "CHEAPEST_ELIGIBLE", "PREFERRED_WITHIN_THRESHOLD", "CHEAPEST_MATCHING_FILTERS", "CHEAPEST_AVAILABLE", "PRESELECTED_SERVICE" ] }, "rate_shop_id": { "type": ["string", "null"] }, "rate_shop_name": { "type": ["string", "null"] }, "requested_rate_label": { "type": ["string", "null"] }, "deliver_by_date": { "type": ["string", "null"] }, "deliver_by_business_days_used": { "type": ["number", "null"], "format": "double" }, "transit_time_restriction": { "type": ["string", "null"] }, "fallback_transit_time": { "type": ["string", "null"] }, "service_preference_enabled": { "type": "boolean" }, "preferred_service_label": { "type": ["string", "null"] }, "preference_threshold_type": { "type": ["string", "null"], "enum": ["CURRENCY", "PERCENTAGE"] }, "preference_threshold": { "type": ["number", "null"], "format": "double" }, "zone": { "type": ["number", "null"], "format": "double" }, "selected_rate": { "oneOf": [ { "$ref": "#/components/schemas/ShippingLabelEvaluatedRate" }, { "type": "null" } ] }, "cheapest_eligible_rate": { "oneOf": [ { "$ref": "#/components/schemas/ShippingLabelEvaluatedRate" }, { "type": "null" } ] }, "preference_delta": { "type": ["number", "null"], "format": "double" }, "eligible_rate_count": { "type": "number", "format": "double" }, "excluded_rate_count": { "type": "number", "format": "double" }, "evaluated_rates": { "items": { "$ref": "#/components/schemas/ShippingLabelEvaluatedRate" }, "type": "array" }, "selection_steps": { "items": { "$ref": "#/components/schemas/ShippingLabelRateSelectionStep" }, "type": "array" }, "configured_service_levels": { "oneOf": [ { "$ref": "#/components/schemas/ShippingLabelConfiguredServiceLevels" }, { "type": "null" } ] }, "available_rate_count_by_integration": { "items": { "$ref": "#/components/schemas/ShippingLabelIntegrationRateSummary" }, "type": "array" }, "rate_fetch_errors": { "items": { "$ref": "#/components/schemas/ShippingLabelRateFetchIssue" }, "type": "array" }, "rate_fetch_decisions": { "items": { "$ref": "#/components/schemas/ShippingLabelRateFetchDecision" }, "type": "array" }, "trace_ref": { "type": ["string", "null"] } }, "required": [ "version", "mode", "summary", "selection_timestamp", "selected_because", "rate_shop_id", "rate_shop_name", "requested_rate_label", "deliver_by_date", "deliver_by_business_days_used", "transit_time_restriction", "fallback_transit_time", "service_preference_enabled", "preferred_service_label", "preference_threshold_type", "preference_threshold", "zone", "selected_rate", "cheapest_eligible_rate", "preference_delta", "eligible_rate_count", "excluded_rate_count", "evaluated_rates", "selection_steps", "configured_service_levels", "available_rate_count_by_integration", "rate_fetch_errors", "trace_ref" ], "type": "object", "additionalProperties": false }, "PackageWithLineItems": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "idempotency_key": { "type": ["string", "null"], "description": "Stable package identity used to reconcile unsaved packing state" }, "created_at": { "type": "string", "format": "date-time", "description": "When the package was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was last updated" }, "name": { "type": "string", "description": "Package name" }, "manifested_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was manifested" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was shipped" }, "status": { "$ref": "#/components/schemas/APIPackageStatus", "description": "Package status" }, "packing_slip_url": { "type": ["string", "null"], "description": "Packing slip URL" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit" }, "type": { "$ref": "#/components/schemas/APIPackageType", "description": "Type" }, "length": { "type": "number", "format": "double", "description": "Length" }, "width": { "type": "number", "format": "double", "description": "Width" }, "height": { "type": "number", "format": "double", "description": "Height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Weight" }, "total_customs_value": { "type": ["number", "null"], "format": "double", "description": "Total customs value" }, "config": { "description": "Package-level shipping config overrides using PackageConfigSchema", "oneOf": [ { "$ref": "#/components/schemas/APIPackageConfig" }, { "type": "null" } ] }, "rate_error_data": { "description": "Structured rate error data", "oneOf": [ { "$ref": "#/components/schemas/APILabelPurchaseError" }, { "type": "null" } ] }, "error_message": { "type": ["string", "null"], "description": "Error message" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "provider_rate_id": { "type": ["string", "null"], "description": "Exact selected provider rate, when available." }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID - when present, creates `FULFILLMENT_ORDER` package with automatic address fallbacks" }, "work_order_id": { "type": ["string", "null"], "description": "Work order ID - when present (without fulfillment_order_id), creates `WORK_ORDER` package" }, "return_id": { "type": ["string", "null"], "description": "Return ID - when present, creates `RETURN` package" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID" }, "scan_form_id": { "type": ["string", "null"], "description": "Scan form ID" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carton_name": { "type": ["string", "null"], "description": "Carton name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "bulk_ship_template_package_id": { "type": ["string", "null"], "description": "Bulk ship template package ID" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse ID" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_address1": { "type": ["string", "null"], "description": "From address street 1" }, "from_address_address2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address ZIP" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_email": { "type": ["string", "null"], "description": "From address email" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_address1": { "type": ["string", "null"], "description": "To address street 1" }, "to_address_address2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address ZIP" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_email": { "type": ["string", "null"], "description": "To address email" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the shipment should be delivered (denormalized from FulfillmentOrder)" }, "line_item_hash": { "type": "string", "description": "Hash of line items for deduplication/matching" }, "total_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of all line items" }, "unique_line_item_count": { "type": "number", "format": "double", "description": "Number of unique line items" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string for the requested carrier/service (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "shipping_label_tracking_code": { "type": ["string", "null"], "description": "Tracking code from shipping label" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Tracking URL from shipping label" }, "shipping_label_formatted_service": { "type": ["string", "null"], "description": "Formatted service display string from shipping label (what was actually bought)" }, "shipping_label_url": { "type": ["string", "null"], "description": "Label URL from shipping label" }, "shipment_status": { "description": "Shipment status from shipping label", "type": ["string", "null"], "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "package_line_items": { "items": { "$ref": "#/components/schemas/APIBasePackageLineItem" }, "type": "array" } }, "required": [ "id", "idempotency_key", "created_at", "updated_at", "name", "manifested_at", "shipped_at", "status", "packing_slip_url", "measurement_unit", "type", "length", "width", "height", "weight_unit", "weight", "total_customs_value", "config", "rate_error_data", "error_message", "carrier_id", "service_id", "picking_session_id", "fulfillment_order_id", "work_order_id", "return_id", "carton_id", "shipping_label_id", "scan_form_id", "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "carton_name", "fulfiller_team_id", "fulfiller_team_name", "bulk_ship_id", "bulk_ship_template_package_id", "warehouse_id", "warehouse_name", "merchant_team_id", "merchant_team_name", "from_address_name", "from_address_company", "from_address_address1", "from_address_address2", "from_address_city", "from_address_state", "from_address_country", "from_address_zip", "from_address_phone", "from_address_email", "to_address_name", "to_address_company", "to_address_address1", "to_address_address2", "to_address_city", "to_address_state", "to_address_country", "to_address_zip", "to_address_phone", "to_address_email", "rate_shop_id", "rate_shop_name", "deliver_by", "line_item_hash", "total_item_quantity", "unique_line_item_count", "formatted_service", "shipping_label_tracking_code", "shipping_label_tracking_url", "shipping_label_formatted_service", "shipping_label_url", "shipment_status", "package_line_items" ], "type": "object", "additionalProperties": false }, "APITrackingEventStatus": { "type": "string", "enum": [ "UNKNOWN", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "DELIVERY_EXCEPTION", "ATTEMPTED_DELIVERY" ] }, "APIBaseTrackingEvent": { "properties": { "raw_data": { "description": "Raw data as JSON" }, "location_country": { "type": ["string", "null"], "description": "Location country" }, "location_zip": { "type": ["string", "null"], "description": "Location zip" }, "location_state": { "type": ["string", "null"], "description": "Location state" }, "location_city": { "type": ["string", "null"], "description": "Location city" }, "event_code": { "type": ["string", "null"], "description": "Event code" }, "event_time": { "type": ["string", "null"], "format": "date-time", "description": "Event time" }, "status_description": { "type": ["string", "null"], "description": "Event status description" }, "status_category": { "type": ["string", "null"], "description": "Event status category" }, "status": { "description": "Event status", "type": ["string", "null"], "enum": [ "UNKNOWN", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "DELIVERY_EXCEPTION", "ATTEMPTED_DELIVERY" ] } }, "required": [ "raw_data", "location_country", "location_zip", "location_state", "location_city", "event_code", "event_time", "status_description", "status_category", "status" ], "type": "object" }, "APIExpandedShippingLabel": { "description": "API type for expanded operations (without supported actions)", "properties": { "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string" }, "tracking_url": { "type": ["string", "null"], "description": "Tracking URL" }, "carrier_correction": { "description": "Latest confirmed carrier correction snapshot, when the label has been corrected", "oneOf": [ { "$ref": "#/components/schemas/ShippingLabelCarrierCorrection" }, { "type": "null" } ] }, "gaylord_id": { "type": ["string", "null"], "description": "Gaylord ID" }, "carrier_account_id": { "type": ["string", "null"], "description": "Carrier account ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "shipment_status": { "$ref": "#/components/schemas/APIShippingLabelShipmentStatus", "description": "Shipment status" }, "refund_status": { "description": "Refund status", "type": ["string", "null"], "enum": ["SUBMITTED", "REJECTED", "REFUNDED"] }, "scan_status": { "$ref": "#/components/schemas/APIShippingLabelScanStatus", "description": "Scan status" }, "label_with_packing_slip_url": { "type": ["string", "null"], "description": "Label with packing slip URL" }, "original_label_url": { "type": ["string", "null"], "description": "Original label URL" }, "label_url": { "type": ["string", "null"], "description": "Label URL" }, "tracking_code": { "type": ["string", "null"], "description": "Tracking code" }, "zone": { "type": ["number", "null"], "format": "double", "description": "Carrier zone" }, "delivery_date_guaranteed": { "type": ["boolean", "null"], "description": "Delivery date guaranteed" }, "delivery_date": { "type": ["string", "null"], "format": "date-time", "description": "Delivery date" }, "delivery_days": { "type": ["string", "null"], "description": "Delivery days" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address zip" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_street2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_street1": { "type": ["string", "null"], "description": "To address street 1" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address zip" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_street2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_street1": { "type": ["string", "null"], "description": "From address street 1" }, "list_currency": { "type": ["string", "null"], "description": "List currency" }, "list_rate": { "type": ["number", "null"], "format": "double", "description": "List rate" }, "retail_currency": { "type": ["string", "null"], "description": "Retail currency" }, "retail_price": { "type": ["number", "null"], "format": "double", "description": "Retail price" }, "currency": { "type": "string", "description": "Currency" }, "price": { "type": "number", "format": "double", "description": "Price" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "remote_bukuship_shipment_id": { "type": ["string", "null"], "description": "Remote Bukuship shipment ID" }, "remote_easypost_tracker_id": { "type": ["string", "null"], "description": "Remote EasyPost tracker ID" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID" }, "voided_at": { "type": ["string", "null"], "format": "date-time", "description": "When the label was voided" }, "shipping_label_number": { "type": "string", "description": "Human-readable shipping label number" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the label was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the label was created" }, "id": { "type": "string", "description": "Unique identifier" }, "rate_selection_details": { "oneOf": [ { "$ref": "#/components/schemas/ShippingLabelRateSelectionDetails" }, { "type": "null" } ] }, "packages": { "items": { "$ref": "#/components/schemas/PackageWithLineItems" }, "type": "array" }, "tracking_events": { "items": { "$ref": "#/components/schemas/APIBaseTrackingEvent" }, "type": "array" } }, "required": [ "formatted_service", "tracking_url", "carrier_correction", "gaylord_id", "carrier_account_id", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "carrier_integration_type", "carrier_integration_name", "carrier_integration_id", "shipment_status", "refund_status", "scan_status", "label_with_packing_slip_url", "original_label_url", "label_url", "tracking_code", "zone", "delivery_date_guaranteed", "delivery_date", "delivery_days", "to_address_name", "to_address_company", "to_address_phone", "to_address_country", "to_address_zip", "to_address_state", "to_address_city", "to_address_street2", "to_address_street1", "from_address_name", "from_address_company", "from_address_phone", "from_address_country", "from_address_zip", "from_address_state", "from_address_city", "from_address_street2", "from_address_street1", "list_currency", "list_rate", "retail_currency", "retail_price", "currency", "price", "carrier_id", "service_id", "remote_bukuship_shipment_id", "remote_easypost_tracker_id", "remote_id", "voided_at", "shipping_label_number", "updated_at", "created_at", "id", "rate_selection_details", "packages", "tracking_events" ], "type": "object", "additionalProperties": false }, "CommercialInvoiceBlockerSeverity": { "enum": ["required", "recommended"], "type": "string" }, "CommercialInvoiceBlockerEnforcement": { "enum": ["blocking", "acknowledgeable"], "type": "string" }, "CommercialInvoiceConfigScope": { "enum": ["ORDER", "WORK_ORDER", "PACKAGE"], "type": "string" }, "CommercialInvoiceBlockerScope": { "properties": { "type": { "$ref": "#/components/schemas/CommercialInvoiceConfigScope" }, "id": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" }, "writable": { "type": "boolean" }, "recommended": { "type": "boolean" }, "disabled_reason": { "type": ["string", "null"] } }, "required": ["type", "id", "ids", "label", "writable", "recommended", "disabled_reason"], "type": "object", "additionalProperties": false }, "CommercialInvoiceBlocker": { "properties": { "key": { "type": "string" }, "field": { "type": "string" }, "label": { "type": "string" }, "message": { "type": "string" }, "rule_code": { "type": "string" }, "severity": { "$ref": "#/components/schemas/CommercialInvoiceBlockerSeverity" }, "enforcement": { "$ref": "#/components/schemas/CommercialInvoiceBlockerEnforcement" }, "current_value": { "anyOf": [ { "type": "string" }, { "type": "number", "format": "double" }, { "type": "boolean" } ], "nullable": true }, "source": { "type": ["string", "null"] }, "currency": { "type": ["string", "null"] }, "unit": { "type": ["string", "null"] }, "allowed_values": { "type": ["array", "null"], "items": { "type": "string" } }, "scopes": { "items": { "$ref": "#/components/schemas/CommercialInvoiceBlockerScope" }, "type": "array" } }, "required": [ "key", "field", "label", "message", "rule_code", "severity", "enforcement", "current_value", "source", "currency", "unit", "allowed_values", "scopes" ], "type": "object", "additionalProperties": false }, "GenerateCommercialInvoiceResult": { "anyOf": [ { "properties": { "invoice_base64": { "type": "string", "nullable": true }, "invoice_url": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": ["success"], "nullable": false } }, "required": ["invoice_base64", "invoice_url", "type"], "type": "object" }, { "properties": { "error": { "properties": { "blockers": { "items": { "$ref": "#/components/schemas/CommercialInvoiceBlocker" }, "type": "array" }, "code": { "type": "string", "enum": ["COMMERCIAL_INVOICE_REQUIREMENTS_NOT_MET"], "nullable": false } }, "required": ["blockers", "code"], "type": "object" }, "type": { "type": "string", "enum": ["error"], "nullable": false } }, "required": ["error", "type"], "type": "object" } ] }, "ShipmentMappingSupportedActionType": { "enum": ["VIEW_SHIPMENT_MAPPING", "UPDATE_SHIPMENT_MAPPING", "DELETE_SHIPMENT_MAPPING"], "type": "string" }, "APISupportedAction_ShipmentMappingSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ShipmentMappingSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIBaseCarrierIntegration": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "name": { "type": "string", "description": "Name" }, "type": { "$ref": "#/components/schemas/APICarrierType", "description": "Type of carrier integration" }, "team_id": { "type": "string", "description": "Team ID" }, "active": { "type": "boolean", "description": "Whether the integration is active" }, "created_at": { "type": "string", "format": "date-time", "description": "When the integration was created" }, "expires_at": { "type": ["string", "null"], "format": "date-time", "description": "When the integration expires" }, "team_name": { "type": "string", "description": "Name of the team" } }, "required": ["id", "name", "type", "team_id", "active", "created_at", "expires_at", "team_name"], "type": "object", "additionalProperties": false }, "APIBaseShop": { "properties": { "authorization_expires_at": { "type": ["string", "null"], "format": "date-time", "description": "Upcoming seller authorization expiry reported by TikTok, when known" }, "order_sync_start_date": { "type": ["string", "null"], "format": "date-time", "description": "Order sync start date (cutoff date)" }, "inventory_sync_enabled": { "type": "boolean", "description": "Whether inventory sync is enabled" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was synced" }, "remote_slug": { "type": ["string", "null"], "description": "Remote slug of the shop" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID of the shop" }, "uninstalled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was uninstalled" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the shop was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the shop was created" }, "slug": { "type": ["string", "null"], "description": "Shop slug" }, "country": { "type": ["string", "null"], "description": "Shop country" }, "domain": { "type": ["string", "null"], "description": "Shop domain" }, "currency": { "type": "string", "description": "Shop currency" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team for this shop" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this shop" }, "type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "name": { "type": "string", "description": "Shop name" }, "id": { "type": "string", "description": "Unique identifier for the shop" } }, "required": [ "authorization_expires_at", "order_sync_start_date", "inventory_sync_enabled", "synced_at", "remote_slug", "remote_id", "uninstalled_at", "updated_at", "created_at", "slug", "country", "domain", "currency", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "type", "name", "id" ], "type": "object" }, "APIMustShip": { "type": "string", "enum": ["SAME_DAY", "NEXT_DAY", "IN_TWO_DAYS"] }, "APIExpandedShipmentMappingWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "team_name": { "type": "string", "description": "The owning team name" }, "team_id": { "type": "string", "description": "The team that owns this shipment mapping" }, "shop_name": { "type": ["string", "null"], "description": "The shop name (denormalized)" }, "shop_id": { "type": ["string", "null"], "description": "The specific shop to match on (null for all shops)" }, "rate_shop_name": { "type": ["string", "null"], "description": "The rate shop profile name" }, "rate_shop_id": { "type": ["string", "null"], "description": "The rate shop profile ID for dynamic rate selection" }, "service_id": { "type": ["string", "null"], "description": "The service ID for the shipping service" }, "carrier_id": { "type": ["string", "null"], "description": "The carrier ID for the shipping service" }, "carrier_integration_name": { "type": ["string", "null"], "description": "The carrier integration name (denormalized)" }, "carrier_integration_id": { "type": ["string", "null"], "description": "The carrier integration to use for purchasing labels" }, "enabled": { "type": "boolean", "description": "Whether this shipment mapping is enabled for runtime routing" }, "enforce_cutoff": { "type": "boolean", "description": "Whether to enforce the cutoff time for SLA" }, "must_ship": { "$ref": "#/components/schemas/APIMustShip", "description": "When the order must ship by (SAME_DAY, NEXT_DAY, IN_TWO_DAYS)" }, "cutoff_time": { "type": "string", "description": "The cutoff time in HH:mm format (e.g., \"14:00\")" }, "wildcard": { "type": "boolean", "description": "Whether this is a wildcard match (e.g., \"usps_\" matches \"usps_ground\")" }, "shipping_method": { "type": "string", "description": "The shipping method name to match against" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the shipment mapping was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the shipment mapping was created" }, "id": { "type": "string", "description": "Unique identifier" }, "carrier_integration": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseCarrierIntegration" }, { "type": "null" } ] }, "shop": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseShop" }, { "type": "null" } ] }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ShipmentMappingSupportedActionType_" }, "type": "array" } }, "required": [ "team_name", "team_id", "shop_name", "shop_id", "rate_shop_name", "rate_shop_id", "service_id", "carrier_id", "carrier_integration_name", "carrier_integration_id", "enabled", "enforce_cutoff", "must_ship", "cutoff_time", "wildcard", "shipping_method", "updated_at", "created_at", "id", "carrier_integration", "shop", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedShipmentMapping": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "team_name": { "type": "string", "description": "The owning team name" }, "team_id": { "type": "string", "description": "The team that owns this shipment mapping" }, "shop_name": { "type": ["string", "null"], "description": "The shop name (denormalized)" }, "shop_id": { "type": ["string", "null"], "description": "The specific shop to match on (null for all shops)" }, "rate_shop_name": { "type": ["string", "null"], "description": "The rate shop profile name" }, "rate_shop_id": { "type": ["string", "null"], "description": "The rate shop profile ID for dynamic rate selection" }, "service_id": { "type": ["string", "null"], "description": "The service ID for the shipping service" }, "carrier_id": { "type": ["string", "null"], "description": "The carrier ID for the shipping service" }, "carrier_integration_name": { "type": ["string", "null"], "description": "The carrier integration name (denormalized)" }, "carrier_integration_id": { "type": ["string", "null"], "description": "The carrier integration to use for purchasing labels" }, "enabled": { "type": "boolean", "description": "Whether this shipment mapping is enabled for runtime routing" }, "enforce_cutoff": { "type": "boolean", "description": "Whether to enforce the cutoff time for SLA" }, "must_ship": { "$ref": "#/components/schemas/APIMustShip", "description": "When the order must ship by (SAME_DAY, NEXT_DAY, IN_TWO_DAYS)" }, "cutoff_time": { "type": "string", "description": "The cutoff time in HH:mm format (e.g., \"14:00\")" }, "wildcard": { "type": "boolean", "description": "Whether this is a wildcard match (e.g., \"usps_\" matches \"usps_ground\")" }, "shipping_method": { "type": "string", "description": "The shipping method name to match against" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the shipment mapping was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the shipment mapping was created" }, "id": { "type": "string", "description": "Unique identifier" }, "carrier_integration": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseCarrierIntegration" }, { "type": "null" } ] }, "shop": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseShop" }, { "type": "null" } ] } }, "required": [ "team_name", "team_id", "shop_name", "shop_id", "rate_shop_name", "rate_shop_id", "service_id", "carrier_id", "carrier_integration_name", "carrier_integration_id", "enabled", "enforce_cutoff", "must_ship", "cutoff_time", "wildcard", "shipping_method", "updated_at", "created_at", "id", "carrier_integration", "shop" ], "type": "object", "additionalProperties": false }, "APICreateShipmentMappingInput": { "description": "Input for creating a shipment mapping", "properties": { "shipping_method": { "type": "string", "description": "The shipping method name to match against" }, "wildcard": { "type": "boolean", "description": "Whether this is a wildcard match (e.g., \"usps_\" matches \"usps_ground\")" }, "cutoff_time": { "type": "string", "description": "The cutoff time in HH:mm format (e.g., \"14:00\")" }, "must_ship": { "$ref": "#/components/schemas/APIMustShip", "description": "When the order must ship by" }, "enforce_cutoff": { "type": "boolean", "description": "Whether to enforce the cutoff time for SLA" }, "enabled": { "type": "boolean", "description": "Whether this shipment mapping is enabled for runtime routing" }, "carrier_integration_id": { "type": ["string", "null"], "description": "The carrier integration to use for purchasing labels" }, "carrier_id": { "type": ["string", "null"], "description": "The carrier ID for the shipping service" }, "service_id": { "type": ["string", "null"], "description": "The service ID for the shipping service" }, "rate_shop_id": { "type": ["string", "null"], "description": "The rate shop profile ID for dynamic rate selection" }, "shop_id": { "type": ["string", "null"], "description": "The specific shop to match on (null for all shops)" } }, "required": ["shipping_method"], "type": "object", "additionalProperties": false }, "APIUpdateShipmentMappingInput": { "description": "Input for updating a shipment mapping", "properties": { "shipping_method": { "type": "string", "description": "The shipping method name to match against" }, "wildcard": { "type": "boolean", "description": "Whether this is a wildcard match (e.g., \"usps_\" matches \"usps_ground\")" }, "cutoff_time": { "type": "string", "description": "The cutoff time in HH:mm format (e.g., \"14:00\")" }, "must_ship": { "$ref": "#/components/schemas/APIMustShip", "description": "When the order must ship by" }, "enforce_cutoff": { "type": "boolean", "description": "Whether to enforce the cutoff time for SLA" }, "enabled": { "type": "boolean", "description": "Whether this shipment mapping is enabled for runtime routing" }, "carrier_integration_id": { "type": ["string", "null"], "description": "The carrier integration to use for purchasing labels" }, "carrier_id": { "type": ["string", "null"], "description": "The carrier ID for the shipping service" }, "service_id": { "type": ["string", "null"], "description": "The service ID for the shipping service" }, "rate_shop_id": { "type": ["string", "null"], "description": "The rate shop profile ID for dynamic rate selection" }, "shop_id": { "type": ["string", "null"], "description": "The specific shop to match on (null for all shops)" } }, "type": "object", "additionalProperties": false }, "APIMinimalShipmentMappingWithActions": { "description": "API type for get-many operations (with supported actions)", "properties": { "team_name": { "type": "string", "description": "The owning team name" }, "team_id": { "type": "string", "description": "The team that owns this shipment mapping" }, "shop_name": { "type": ["string", "null"], "description": "The shop name (denormalized)" }, "shop_id": { "type": ["string", "null"], "description": "The specific shop to match on (null for all shops)" }, "rate_shop_name": { "type": ["string", "null"], "description": "The rate shop profile name" }, "rate_shop_id": { "type": ["string", "null"], "description": "The rate shop profile ID for dynamic rate selection" }, "service_id": { "type": ["string", "null"], "description": "The service ID for the shipping service" }, "carrier_id": { "type": ["string", "null"], "description": "The carrier ID for the shipping service" }, "carrier_integration_name": { "type": ["string", "null"], "description": "The carrier integration name (denormalized)" }, "carrier_integration_id": { "type": ["string", "null"], "description": "The carrier integration to use for purchasing labels" }, "enabled": { "type": "boolean", "description": "Whether this shipment mapping is enabled for runtime routing" }, "enforce_cutoff": { "type": "boolean", "description": "Whether to enforce the cutoff time for SLA" }, "must_ship": { "$ref": "#/components/schemas/APIMustShip", "description": "When the order must ship by (SAME_DAY, NEXT_DAY, IN_TWO_DAYS)" }, "cutoff_time": { "type": "string", "description": "The cutoff time in HH:mm format (e.g., \"14:00\")" }, "wildcard": { "type": "boolean", "description": "Whether this is a wildcard match (e.g., \"usps_\" matches \"usps_ground\")" }, "shipping_method": { "type": "string", "description": "The shipping method name to match against" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the shipment mapping was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the shipment mapping was created" }, "id": { "type": "string", "description": "Unique identifier" }, "shop": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseShop" }, { "type": "null" } ] }, "carrier_integration": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseCarrierIntegration" }, { "type": "null" } ] }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ShipmentMappingSupportedActionType_" }, "type": "array" } }, "required": [ "team_name", "team_id", "shop_name", "shop_id", "rate_shop_name", "rate_shop_id", "service_id", "carrier_id", "carrier_integration_name", "carrier_integration_id", "enabled", "enforce_cutoff", "must_ship", "cutoff_time", "wildcard", "shipping_method", "updated_at", "created_at", "id", "shop", "carrier_integration", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalShipmentMappingWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalShipmentMappingWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyShipmentMappingsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalShipmentMappingWithActions_", "description": "Response type for get-many operations" }, "RateCardSupportedActionType": { "enum": ["VIEW_RATE_CARD", "UPDATE_RATE_CARD", "DELETE_RATE_CARD", "CREATE_RATE", "DUPLICATE_RATE_CARD"], "type": "string" }, "APISupportedAction_RateCardSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/RateCardSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIRatePeriod": { "type": "string", "enum": ["DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY", "YEARLY"] }, "APIExpandedRateCardWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "team_id": { "type": "string", "description": "ID of team that owns this rate card" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the rate card was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the rate card was created" }, "currency": { "type": "string", "description": "Currency of the rate card" }, "subscription_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for subscription amount billing" }, "subscription_amount": { "type": "number", "format": "double", "description": "Subscription amount to bill per period" }, "minimum_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for minimum amount billing" }, "minimum_amount": { "type": "number", "format": "double", "description": "Minimum amount to bill per period" }, "description": { "type": ["string", "null"], "description": "Description of the rate card" }, "name": { "type": "string", "description": "Name of the rate card" }, "id": { "type": "string", "description": "Unique identifier for the rate card" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_RateCardSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "team_id", "updated_at", "created_at", "currency", "subscription_period", "subscription_amount", "minimum_period", "minimum_amount", "description", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedRateCard": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "team_id": { "type": "string", "description": "ID of team that owns this rate card" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the rate card was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the rate card was created" }, "currency": { "type": "string", "description": "Currency of the rate card" }, "subscription_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for subscription amount billing" }, "subscription_amount": { "type": "number", "format": "double", "description": "Subscription amount to bill per period" }, "minimum_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for minimum amount billing" }, "minimum_amount": { "type": "number", "format": "double", "description": "Minimum amount to bill per period" }, "description": { "type": ["string", "null"], "description": "Description of the rate card" }, "name": { "type": "string", "description": "Name of the rate card" }, "id": { "type": "string", "description": "Unique identifier for the rate card" } }, "required": [ "team_id", "updated_at", "created_at", "currency", "subscription_period", "subscription_amount", "minimum_period", "minimum_amount", "description", "name", "id" ], "type": "object", "additionalProperties": false }, "APICreateRateCardInput": { "description": "Input for creating a new rate card", "properties": { "name": { "type": "string", "description": "Name of the rate card" }, "description": { "type": ["string", "null"], "description": "Description of the rate card" }, "minimum_amount": { "type": "number", "format": "double", "description": "Minimum amount to bill per period" }, "minimum_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for minimum amount billing" }, "subscription_amount": { "type": "number", "format": "double", "description": "Subscription amount to bill per period" }, "subscription_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for subscription amount billing" } }, "required": ["name"], "type": "object", "additionalProperties": false }, "APIUpdateRateCardInput": { "description": "Input for updating a rate card - all fields are optional for partial updates", "properties": { "name": { "type": "string", "description": "Name of the rate card" }, "description": { "type": ["string", "null"], "description": "Description of the rate card" }, "minimum_amount": { "type": "number", "format": "double", "description": "Minimum amount to bill per period" }, "minimum_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for minimum amount billing" }, "subscription_amount": { "type": "number", "format": "double", "description": "Subscription amount to bill per period" }, "subscription_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for subscription amount billing" } }, "type": "object", "additionalProperties": false }, "APIMinimalRateCardWithActions": { "description": "API Rate Card with minimal data and supported actions for public API", "properties": { "team_id": { "type": "string", "description": "ID of team that owns this rate card" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the rate card was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the rate card was created" }, "currency": { "type": "string", "description": "Currency of the rate card" }, "subscription_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for subscription amount billing" }, "subscription_amount": { "type": "number", "format": "double", "description": "Subscription amount to bill per period" }, "minimum_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for minimum amount billing" }, "minimum_amount": { "type": "number", "format": "double", "description": "Minimum amount to bill per period" }, "description": { "type": ["string", "null"], "description": "Description of the rate card" }, "name": { "type": "string", "description": "Name of the rate card" }, "id": { "type": "string", "description": "Unique identifier for the rate card" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_RateCardSupportedActionType_" }, "type": "array", "description": "Supported actions for this rate card" } }, "required": [ "team_id", "updated_at", "created_at", "currency", "subscription_period", "subscription_amount", "minimum_period", "minimum_amount", "description", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalRateCardWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalRateCardWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyRateCardsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalRateCardWithActions_", "description": "Response type for get-many operations with rate cards" }, "PurchaseOrderSupportedActionType": { "enum": [ "VIEW_PURCHASE_ORDER", "UPDATE_PURCHASE_ORDER", "IMPORT_PURCHASE_ORDER_CSV", "EXPORT_PURCHASE_ORDER_CSV", "DELETE_PURCHASE_ORDER", "RECEIVE_PURCHASE_ORDER" ], "type": "string" }, "APISupportedAction_PurchaseOrderSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/PurchaseOrderSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIBasePurchaseOrderLineItemLot": { "properties": { "purchase_order_line_item_id": { "type": "string", "description": "The purchase order line item that this lot belongs to" }, "location_name": { "type": ["string", "null"], "description": "Denormalized: The name of the location" }, "location_id": { "type": ["string", "null"], "description": "What location to receive these items to" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "The expiration date of the product - used to identify when a batch of items are expected to expire" }, "lot_code": { "type": ["string", "null"], "description": "The lot code of the product - used for identifying the batch of items that are coming in" }, "accepted_quantity": { "type": "number", "format": "double", "description": "How many items for this lot were accepted" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order line item lot was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order line item lot was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "purchase_order_line_item_id", "location_name", "location_id", "expiration_date", "lot_code", "accepted_quantity", "updated_at", "created_at", "id" ], "type": "object" }, "APIBasePurchaseOrderLineItemRejectionAttachment": { "properties": { "file_thumbnail_url": { "type": ["string", "null"], "description": "Denormalized: The file thumbnail URL" }, "file_url": { "type": ["string", "null"], "description": "Denormalized: The file URL" }, "file_name": { "type": ["string", "null"], "description": "Denormalized: The file name" }, "file_id": { "type": "string", "description": "The file that this attachment references" }, "purchase_order_line_item_rejection_id": { "type": "string", "description": "The purchase order line item rejection that this attachment belongs to" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order line item rejection attachment was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order line item rejection attachment was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "file_thumbnail_url", "file_url", "file_name", "file_id", "purchase_order_line_item_rejection_id", "updated_at", "created_at", "id" ], "type": "object" }, "PurchaseOrderLineItemRejectionWithAttachments": { "properties": { "purchase_order_line_item_id": { "type": "string", "description": "The purchase order line item that this rejection belongs to" }, "note": { "type": ["string", "null"], "description": "Any additional note for the rejection" }, "reason": { "type": "string", "description": "The reason for the rejection (Damaged, expired, etc)" }, "quantity": { "type": "number", "format": "double", "description": "The quantity that was rejected" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order line item rejection was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order line item rejection was created" }, "id": { "type": "string", "description": "Unique identifier" }, "attachments": { "items": { "$ref": "#/components/schemas/APIBasePurchaseOrderLineItemRejectionAttachment" }, "type": "array" } }, "required": [ "purchase_order_line_item_id", "note", "reason", "quantity", "updated_at", "created_at", "id", "attachments" ], "type": "object", "additionalProperties": false }, "APIBasePurchaseOrderLineItemAttachment": { "properties": { "file_thumbnail_url": { "type": ["string", "null"], "description": "Denormalized: The file thumbnail URL" }, "file_url": { "type": ["string", "null"], "description": "Denormalized: The file URL" }, "file_name": { "type": ["string", "null"], "description": "Denormalized: The file name" }, "file_id": { "type": "string", "description": "The file that this attachment references" }, "purchase_order_line_item_id": { "type": "string", "description": "The purchase order line item that this attachment belongs to" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order line item attachment was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order line item attachment was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "file_thumbnail_url", "file_url", "file_name", "file_id", "purchase_order_line_item_id", "updated_at", "created_at", "id" ], "type": "object" }, "APIPurchaseOrderLineItemInventoryStatus": { "type": "string", "enum": ["UNRECEIVED", "RECEIVED", "PARTIALLY_RECEIVED", "OVER_RECEIVED"] }, "APIExpandedPurchaseOrderLineItem": { "properties": { "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized: The UoM profile multiplier to eaches" }, "uom_label": { "type": ["string", "null"], "description": "Denormalized: The UoM profile label (e.g., \"Pallet\", \"Master Case\")" }, "uom_profile_id": { "type": ["string", "null"], "description": "UoM profile ID for this line item (null = eaches)" }, "purchase_order_id": { "type": "string", "description": "The purchase order that this purchase order line item is for" }, "product_first_article_inspection_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Denormalized: When the first article inspection was completed for the product" }, "image_url": { "type": ["string", "null"], "description": "Denormalized: The product image URL" }, "name": { "type": "string", "description": "Denormalized: The product name" }, "sku": { "type": ["string", "null"], "description": "Denormalized: The product SKU" }, "product_id": { "type": ["string", "null"], "description": "The product that this purchase order line item is for" }, "item_price": { "type": "number", "format": "double", "description": "The unit cost / purchase price of the item" }, "sell_ahead": { "type": "number", "format": "double", "description": "The sell ahead quantity of the product - number of items that should be sold before the product is received" }, "manufacturer_sku": { "type": ["string", "null"], "description": "The manufacturer's SKU of the product" }, "accepted_quantity": { "type": "number", "format": "double", "description": "How many items have been accepted/received at the warehouse" }, "ordered_quantity": { "type": "number", "format": "double", "description": "How many items were ordered/expected to arrive at the warehouse" }, "location_name": { "type": ["string", "null"], "description": "Denormalized: The name of the location" }, "location_id": { "type": ["string", "null"], "description": "Which location to receive the products to" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderLineItemInventoryStatus", "description": "The inventory status of the purchase order line item" }, "order": { "type": "number", "format": "double", "description": "Order to maintain the order of the items" }, "ordered_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order line item was ordered" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order line item was created" }, "id": { "type": "string", "description": "Unique identifier" }, "purchase_order_line_item_lots": { "items": { "$ref": "#/components/schemas/APIBasePurchaseOrderLineItemLot" }, "type": "array" }, "purchase_order_line_item_rejections": { "items": { "$ref": "#/components/schemas/PurchaseOrderLineItemRejectionWithAttachments" }, "type": "array" }, "attachments": { "items": { "$ref": "#/components/schemas/APIBasePurchaseOrderLineItemAttachment" }, "type": "array" } }, "required": [ "uom_multiplier_to_eaches", "uom_label", "uom_profile_id", "purchase_order_id", "product_first_article_inspection_completed_at", "image_url", "name", "sku", "product_id", "item_price", "sell_ahead", "manufacturer_sku", "accepted_quantity", "ordered_quantity", "location_name", "location_id", "inventory_status", "order", "ordered_at", "updated_at", "created_at", "id", "purchase_order_line_item_lots", "purchase_order_line_item_rejections", "attachments" ], "type": "object", "additionalProperties": false }, "APIPurchaseOrderOrderStatus": { "type": "string", "enum": ["PENDING", "CLOSED"] }, "APIPurchaseOrderInventoryStatus": { "type": "string", "enum": ["UNRECEIVED", "RECEIVED", "PARTIALLY_RECEIVED"] }, "APIExpandedPurchaseOrderWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "purchase_order_number": { "type": "string", "description": "Human-readable purchase order number, auto-incremented per fulfiller team" }, "receiving_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when receiving started" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was shipped" }, "expected_at": { "type": ["string", "null"], "format": "date-time", "description": "Expected arrival date for the purchase order" }, "shipping": { "type": "number", "format": "double", "description": "Shipping cost for the purchase order" }, "discount": { "type": "number", "format": "double", "description": "Discount applied to the purchase order" }, "name": { "type": ["string", "null"], "description": "Name of the purchase order" }, "tracking_number": { "type": ["string", "null"], "description": "Tracking number for the purchase order" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderInventoryStatus", "description": "Inventory status" }, "order_status": { "$ref": "#/components/schemas/APIPurchaseOrderOrderStatus", "description": "Order status" }, "warehouse_note": { "type": ["string", "null"], "description": "Note for the warehouse" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "vendor_name": { "type": ["string", "null"], "description": "Vendor name" }, "vendor_id": { "type": ["string", "null"], "description": "Vendor ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "currency": { "type": "string", "description": "Currency for the purchase order" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "total_price": { "type": "number", "format": "double" }, "total_accepted": { "type": "number", "format": "double" }, "total_ordered": { "type": "number", "format": "double" }, "purchase_order_line_items": { "items": { "$ref": "#/components/schemas/APIExpandedPurchaseOrderLineItem" }, "type": "array" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_PurchaseOrderSupportedActionType_" }, "type": "array" } }, "required": [ "purchase_order_number", "receiving_started_at", "shipped_at", "expected_at", "shipping", "discount", "name", "tracking_number", "inventory_status", "order_status", "warehouse_note", "warehouse_name", "warehouse_id", "vendor_name", "vendor_id", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "currency", "updated_at", "created_at", "id", "total_price", "total_accepted", "total_ordered", "purchase_order_line_items", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIMinimalPurchaseOrder": { "description": "API Purchase Order with minimal data for public API", "properties": { "purchase_order_number": { "type": "string", "description": "Human-readable purchase order number, auto-incremented per fulfiller team" }, "receiving_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when receiving started" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was shipped" }, "expected_at": { "type": ["string", "null"], "format": "date-time", "description": "Expected arrival date for the purchase order" }, "shipping": { "type": "number", "format": "double", "description": "Shipping cost for the purchase order" }, "discount": { "type": "number", "format": "double", "description": "Discount applied to the purchase order" }, "name": { "type": ["string", "null"], "description": "Name of the purchase order" }, "tracking_number": { "type": ["string", "null"], "description": "Tracking number for the purchase order" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderInventoryStatus", "description": "Inventory status" }, "order_status": { "$ref": "#/components/schemas/APIPurchaseOrderOrderStatus", "description": "Order status" }, "warehouse_note": { "type": ["string", "null"], "description": "Note for the warehouse" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "vendor_name": { "type": ["string", "null"], "description": "Vendor name" }, "vendor_id": { "type": ["string", "null"], "description": "Vendor ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "currency": { "type": "string", "description": "Currency for the purchase order" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "purchase_order_number", "receiving_started_at", "shipped_at", "expected_at", "shipping", "discount", "name", "tracking_number", "inventory_status", "order_status", "warehouse_note", "warehouse_name", "warehouse_id", "vendor_name", "vendor_id", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "currency", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalPurchaseOrder_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalPurchaseOrder" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyPurchaseOrdersResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalPurchaseOrder_", "description": "Response type for get-many operations" }, "APIExpandedPurchaseOrder": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "purchase_order_number": { "type": "string", "description": "Human-readable purchase order number, auto-incremented per fulfiller team" }, "receiving_started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when receiving started" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was shipped" }, "expected_at": { "type": ["string", "null"], "format": "date-time", "description": "Expected arrival date for the purchase order" }, "shipping": { "type": "number", "format": "double", "description": "Shipping cost for the purchase order" }, "discount": { "type": "number", "format": "double", "description": "Discount applied to the purchase order" }, "name": { "type": ["string", "null"], "description": "Name of the purchase order" }, "tracking_number": { "type": ["string", "null"], "description": "Tracking number for the purchase order" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderInventoryStatus", "description": "Inventory status" }, "order_status": { "$ref": "#/components/schemas/APIPurchaseOrderOrderStatus", "description": "Order status" }, "warehouse_note": { "type": ["string", "null"], "description": "Note for the warehouse" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "vendor_name": { "type": ["string", "null"], "description": "Vendor name" }, "vendor_id": { "type": ["string", "null"], "description": "Vendor ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "currency": { "type": "string", "description": "Currency for the purchase order" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the purchase order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "total_price": { "type": "number", "format": "double" }, "total_accepted": { "type": "number", "format": "double" }, "total_ordered": { "type": "number", "format": "double" }, "purchase_order_line_items": { "items": { "$ref": "#/components/schemas/APIExpandedPurchaseOrderLineItem" }, "type": "array" } }, "required": [ "purchase_order_number", "receiving_started_at", "shipped_at", "expected_at", "shipping", "discount", "name", "tracking_number", "inventory_status", "order_status", "warehouse_note", "warehouse_name", "warehouse_id", "vendor_name", "vendor_id", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "currency", "updated_at", "created_at", "id", "total_price", "total_accepted", "total_ordered", "purchase_order_line_items" ], "type": "object", "additionalProperties": false }, "ShipOSAPICreatePurchaseOrderLineItemInput": { "properties": { "purchase_order_line_item_id": { "type": "string", "description": "ID of existing line item (for updates)" }, "product_id": { "type": ["string", "null"], "description": "ID of the product being ordered" }, "name": { "type": "string", "description": "Item name, required for a new custom item (product_id: null)." }, "sku": { "type": ["string", "null"], "description": "Custom item SKU; does not enable product scanning." }, "image_url": { "type": ["string", "null"], "description": "Custom item image URL." }, "ordered_quantity": { "type": "number", "format": "double", "description": "Quantity ordered" }, "accepted_quantity": { "type": "number", "format": "double", "description": "Quantity accepted during receiving" }, "uom_profile_id": { "type": ["string", "null"], "description": "UoM profile ID for package-level receiving" }, "item_price": { "type": "number", "format": "double", "description": "Price per item" }, "manufacturer_sku": { "type": ["string", "null"], "description": "Manufacturer SKU" }, "sell_ahead": { "type": "number", "format": "double", "description": "Number of units to sell ahead" }, "ordered_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the line item was ordered" }, "order": { "type": "number", "format": "double", "description": "Order sequence for the line item" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderLineItemInventoryStatus", "description": "Inventory status for this line item" }, "file_ids": { "items": { "type": "string" }, "type": "array", "description": "File IDs attached to this line item" }, "location_id": { "type": "string", "description": "Location ID where this line item will be received" }, "purchase_order_line_item_lots": { "items": { "properties": { "location_id": { "type": "string", "description": "Location ID for this lot" }, "accepted_quantity": { "type": "number", "format": "double", "description": "Quantity accepted for this lot" }, "expiration_date": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiration date for this lot" }, "lot_code": { "type": "string", "nullable": true, "description": "Lot code" }, "purchase_order_line_item_lot_id": { "type": "string", "description": "ID of existing lot (for updates)" } }, "type": "object" }, "type": "array", "description": "Lot information for this line item" }, "purchase_order_line_item_rejections": { "items": { "properties": { "file_ids": { "items": { "type": "string" }, "type": "array", "description": "File IDs attached to this rejection" }, "note": { "type": "string", "description": "Additional notes about the rejection" }, "reason": { "type": "string", "description": "Reason for rejection" }, "quantity": { "type": "number", "format": "double", "description": "Quantity rejected" }, "purchase_order_line_item_rejection_id": { "type": "string", "description": "ID of existing rejection (for updates)" } }, "required": ["reason", "quantity"], "type": "object" }, "type": "array", "description": "Rejection information for this line item" } }, "required": ["product_id", "ordered_quantity", "item_price"], "type": "object", "additionalProperties": false }, "ShipOSAPICreatePurchaseOrderInput": { "description": "ShipOS API input for creating purchase orders. Team is derived from the API key.", "properties": { "name": { "type": ["string", "null"], "description": "Name of the purchase order" }, "purchase_order_number": { "type": "string", "description": "Optional purchase order number - if not provided, will be auto-generated" }, "currency": { "type": "string", "description": "Currency for the purchase order" }, "discount": { "type": "number", "format": "double", "description": "Discount amount applied to the purchase order" }, "shipping": { "type": "number", "format": "double", "description": "Shipping cost for the purchase order" }, "expected_at": { "type": ["string", "null"], "format": "date-time", "description": "Expected arrival date for the purchase order" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was shipped" }, "tracking_number": { "type": ["string", "null"], "description": "Tracking number for the purchase order shipment" }, "warehouse_note": { "type": ["string", "null"], "description": "Note for the warehouse regarding this purchase order" }, "order_status": { "$ref": "#/components/schemas/APIPurchaseOrderOrderStatus", "description": "Order status" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderInventoryStatus", "description": "Inventory status" }, "merchant_team_id": { "type": ["string", "null"], "description": "ID of the merchant team" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse where goods will be received" }, "purchase_order_line_items": { "items": { "$ref": "#/components/schemas/ShipOSAPICreatePurchaseOrderLineItemInput" }, "type": "array", "description": "Line items for the purchase order" } }, "required": ["warehouse_id", "purchase_order_line_items"], "type": "object", "additionalProperties": false }, "ShipOSAPIUpdatePurchaseOrderLineItemInput": { "properties": { "purchase_order_line_item_id": { "type": "string", "description": "ID of existing line item (for updates)" }, "product_id": { "type": ["string", "null"], "description": "ID of the product being ordered" }, "name": { "type": "string", "description": "Item name, required for a new custom item (product_id: null)." }, "sku": { "type": ["string", "null"], "description": "Custom item SKU; does not enable product scanning." }, "image_url": { "type": ["string", "null"], "description": "Custom item image URL." }, "ordered_quantity": { "type": "number", "format": "double", "description": "Quantity ordered" }, "accepted_quantity": { "type": "number", "format": "double", "description": "Quantity accepted during receiving" }, "uom_profile_id": { "type": ["string", "null"], "description": "UoM profile ID for package-level receiving" }, "item_price": { "type": "number", "format": "double", "description": "Price per item" }, "manufacturer_sku": { "type": ["string", "null"], "description": "Manufacturer SKU" }, "sell_ahead": { "type": "number", "format": "double", "description": "Number of units to sell ahead" }, "ordered_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the line item was ordered" }, "order": { "type": "number", "format": "double", "description": "Order sequence for the line item" }, "inventory_status": { "$ref": "#/components/schemas/APIPurchaseOrderLineItemInventoryStatus", "description": "Inventory status for this line item" }, "file_ids": { "items": { "type": "string" }, "type": "array", "description": "File IDs attached to this line item" }, "location_id": { "type": "string", "description": "Location ID where this line item will be received" }, "purchase_order_line_item_lots": { "items": { "properties": { "location_id": { "type": "string", "description": "Location ID for this lot" }, "accepted_quantity": { "type": "number", "format": "double", "description": "Quantity accepted for this lot" }, "expiration_date": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiration date for this lot" }, "lot_code": { "type": "string", "nullable": true, "description": "Lot code" }, "purchase_order_line_item_lot_id": { "type": "string", "description": "ID of existing lot (for updates)" } }, "type": "object" }, "type": "array", "description": "Lot information for this line item" }, "purchase_order_line_item_rejections": { "items": { "properties": { "file_ids": { "items": { "type": "string" }, "type": "array", "description": "File IDs attached to this rejection" }, "note": { "type": "string", "description": "Additional notes about the rejection" }, "reason": { "type": "string", "description": "Reason for rejection" }, "quantity": { "type": "number", "format": "double", "description": "Quantity rejected" }, "purchase_order_line_item_rejection_id": { "type": "string", "description": "ID of existing rejection (for updates)" } }, "required": ["reason", "quantity"], "type": "object" }, "type": "array", "description": "Rejection information for this line item" } }, "required": ["product_id", "ordered_quantity", "item_price"], "type": "object", "additionalProperties": false }, "ShipOSAPIUpdatePurchaseOrderInput": { "description": "ShipOS API input for updating purchase orders.", "properties": { "name": { "type": ["string", "null"], "description": "Name of the purchase order" }, "purchase_order_number": { "type": "string", "description": "Human-readable purchase order number" }, "discount": { "type": "number", "format": "double", "description": "Discount amount applied to the purchase order" }, "shipping": { "type": "number", "format": "double", "description": "Shipping cost for the purchase order" }, "expected_at": { "type": ["string", "null"], "format": "date-time", "description": "Expected arrival date for the purchase order" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the purchase order was shipped" }, "tracking_number": { "type": ["string", "null"], "description": "Tracking number for the purchase order shipment" }, "warehouse_note": { "type": ["string", "null"], "description": "Note for the warehouse regarding this purchase order" }, "order_status": { "$ref": "#/components/schemas/APIPurchaseOrderOrderStatus", "description": "Order status" }, "vendor_id": { "type": ["string", "null"], "description": "ID of the vendor" }, "purchase_order_line_items": { "items": { "$ref": "#/components/schemas/ShipOSAPIUpdatePurchaseOrderLineItemInput" }, "type": "array", "description": "Line items for the purchase order" } }, "type": "object", "additionalProperties": false }, "ProductSupportedActionType": { "enum": [ "VIEW_PRODUCT", "UPDATE_PRODUCT", "PRINT_BARCODE", "DELETE_PRODUCT", "SYNC_INVENTORY", "STOCK_PRODUCT", "VIEW_INVENTORY_HISTORY" ], "type": "string" }, "APISupportedAction_ProductSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ProductSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "Operation": { "properties": { "count": { "type": "number", "format": "double" }, "label": { "type": "string" } }, "required": ["count", "label"], "type": "object" }, "OperationPayload": { "properties": { "operations": { "items": { "$ref": "#/components/schemas/Operation" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": ["operations", "count"], "type": "object" }, "APIWarehouseInventoryBreakdown": { "properties": { "on_order": { "$ref": "#/components/schemas/OperationPayload" }, "unavailable": { "$ref": "#/components/schemas/OperationPayload" }, "committed": { "$ref": "#/components/schemas/OperationPayload" }, "on_hand": { "$ref": "#/components/schemas/OperationPayload" }, "available": { "$ref": "#/components/schemas/OperationPayload" }, "warehouse_name": { "type": "string" }, "warehouse_id": { "type": "string" } }, "required": ["on_order", "unavailable", "committed", "on_hand", "available", "warehouse_name", "warehouse_id"], "type": "object" }, "APIBaseVirtualBundleComponent": { "properties": { "component_product_image_url": { "type": ["string", "null"], "description": "Denormalized component product image URL" }, "component_product_sku": { "type": ["string", "null"], "description": "Denormalized component product SKU" }, "component_product_name": { "type": "string", "description": "Denormalized component product name" }, "component_product_id": { "type": "string", "description": "Component product ID" }, "virtual_bundle_product_id": { "type": "string", "description": "Virtual bundle product ID" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the component was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the component was created" }, "component_quantity": { "type": "number", "format": "double", "description": "Component quantity" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "component_product_image_url", "component_product_sku", "component_product_name", "component_product_id", "virtual_bundle_product_id", "updated_at", "created_at", "component_quantity", "id" ], "type": "object" }, "APIBaseAssemblyComponent": { "properties": { "component_product_image_url": { "type": ["string", "null"], "description": "Denormalized component product image URL" }, "component_product_sku": { "type": ["string", "null"], "description": "Denormalized component product SKU" }, "component_product_name": { "type": "string", "description": "Denormalized component product name" }, "component_product_id": { "type": "string", "description": "Component product ID" }, "assembly_product_id": { "type": "string", "description": "Assembly product ID" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the component was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the component was created" }, "component_quantity": { "type": "number", "format": "double", "description": "Component quantity" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "component_product_image_url", "component_product_sku", "component_product_name", "component_product_id", "assembly_product_id", "updated_at", "created_at", "component_quantity", "id" ], "type": "object" }, "APIBaseProductListingVariant": { "properties": { "shop_slug": { "type": ["string", "null"], "description": "Shop slug" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "remote_shopify_inventory_item_id": { "type": ["string", "null"], "description": "Remote Shopify inventory item ID" }, "shop_id": { "type": "string", "description": "Shop ID" }, "weight_unit": { "description": "Weight unit", "type": ["string", "null"], "enum": ["G", "KG", "OZ", "LB"] }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight" }, "sku": { "type": ["string", "null"], "description": "SKU" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this variant" }, "product_listing_name": { "type": "string", "description": "Product listing name (denormalized from parent ProductListing)" }, "product_listing_id": { "type": "string", "description": "Product listing ID" }, "product_type": { "description": "Product type (denormalized from linked Product)", "type": ["string", "null"], "enum": ["STANDARD", "ASSEMBLY", "VIRTUAL_BUNDLE", "DIGITAL", "UOM"] }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "country_of_origin": { "type": ["string", "null"], "description": "Country of origin" }, "currency": { "type": "string", "description": "Currency" }, "price": { "type": "number", "format": "double", "description": "Price" }, "hs_code": { "type": ["string", "null"], "description": "HS code" }, "barcode": { "type": ["string", "null"], "description": "Barcode" }, "name": { "type": "string", "description": "Variant title" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the variant was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the variant was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "shop_slug", "shop_name", "shop_type", "remote_shopify_inventory_item_id", "shop_id", "weight_unit", "weight", "sku", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "product_listing_name", "product_listing_id", "product_type", "product_id", "image_url", "country_of_origin", "currency", "price", "hs_code", "barcode", "name", "synced_at", "remote_id", "updated_at", "created_at", "id" ], "type": "object" }, "APIProductConfig": { "properties": { "replenishment_source_strategy": { "type": ["string", "null"], "enum": ["FIFO", "FEFO", null] }, "replenishment_increment_level": { "type": ["number", "null"], "format": "double" }, "replenishment_maximum_level": { "type": ["number", "null"], "format": "double" }, "replenishment_minimum_level": { "type": ["number", "null"], "format": "double" } }, "type": "object" }, "Partial_Record_ShopType.number__": { "properties": { "SHOPIFY": { "type": "number", "format": "double" }, "MAGENTO2": { "type": "number", "format": "double" }, "BIGCOMMERCE": { "type": "number", "format": "double" }, "MANUAL": { "type": "number", "format": "double" }, "WOOCOMMERCE": { "type": "number", "format": "double" }, "WIX": { "type": "number", "format": "double" }, "TIKTOK": { "type": "number", "format": "double" } }, "type": "object", "description": "Make all properties in T optional" }, "APIPublicExpandedProductWithActions": { "properties": { "is_hazmat": { "type": "boolean", "description": "Whether the product is classified as hazardous material" }, "subcategory": { "type": ["string", "null"], "description": "Product subcategory" }, "category": { "type": ["string", "null"], "description": "Product category" }, "virtual_bundle_component_count": { "type": "number", "format": "double", "description": "Count of virtual bundles this product is a component of (denormalized for query performance)" }, "product_listing_variant_count": { "$ref": "#/components/schemas/Partial_Record_ShopType.number__", "description": "Count of product listing variants per shop type" }, "pick_fee_override": { "type": ["number", "null"], "format": "double", "description": "Custom pick fee override for this product" }, "printed_commodity_identifier": { "type": ["string", "null"], "description": "International commodity code" }, "eccn": { "type": ["string", "null"], "description": "Export Control Classification Number" }, "manufacturer": { "type": ["string", "null"], "description": "Item manufacturer" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the product was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the product was created" }, "config": { "description": "Product-level config overrides such as replenishment levels and source strategy", "oneOf": [ { "$ref": "#/components/schemas/APIProductConfig" }, { "type": "null" } ] }, "first_article_inspection_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when first article inspection was completed" }, "customs_value_currency": { "type": "string", "description": "Currency code for customs value" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Value declared for customs" }, "customs_description": { "type": ["string", "null"], "description": "Description for customs declaration" }, "country_of_origin": { "type": ["string", "null"], "description": "Country where product was manufactured" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized System code for customs" }, "mpn": { "type": ["string", "null"], "description": "Manufacturer Part Number" }, "image_url": { "type": ["string", "null"], "description": "URL to product image" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Unit of measurement for dimensions (CM, IN)" }, "height": { "type": "number", "format": "double", "description": "Height of the product in measurement_unit" }, "width": { "type": "number", "format": "double", "description": "Width of the product in measurement_unit" }, "length": { "type": "number", "format": "double", "description": "Length of the product in measurement_unit" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Unit of measurement for weight (KG, LB)" }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight of the product in weight_unit" }, "cost_currency": { "type": "string", "description": "Currency code for cost price" }, "cost_price": { "type": ["number", "null"], "format": "double", "description": "Cost price of the product" }, "sku": { "type": ["string", "null"], "description": "Stock keeping unit identifier" }, "description": { "type": ["string", "null"], "description": "Product description" }, "type": { "$ref": "#/components/schemas/APIProductType", "description": "Type of product (STANDARD, VIRTUAL_BUNDLE, ASSEMBLY)" }, "name": { "type": "string", "description": "Name of the product" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this product" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this product" }, "id": { "type": "string", "description": "Unique identifier for the product" }, "available": { "type": "number", "format": "double", "description": "Available inventory (sum across all warehouses)" }, "on_hand": { "type": "number", "format": "double", "description": "On-hand inventory (sum across all warehouses)" }, "committed": { "type": "number", "format": "double", "description": "Committed inventory (sum across all warehouses)" }, "unavailable": { "type": "number", "format": "double", "description": "Unavailable inventory (sum across all warehouses)" }, "on_order": { "type": "number", "format": "double", "description": "On-order inventory (ordered but not yet received, sum across all warehouses)" }, "inventory_by_warehouse": { "items": { "$ref": "#/components/schemas/APIWarehouseInventoryBreakdown" }, "type": "array", "description": "Inventory breakdown by warehouse with detailed operations" }, "virtual_bundle_products": { "items": { "$ref": "#/components/schemas/APIBaseVirtualBundleComponent" }, "type": "array", "description": "Virtual bundle products. Only returned when product.type is VIRTUAL_BUNDLE" }, "assembly_products": { "items": { "$ref": "#/components/schemas/APIBaseAssemblyComponent" }, "type": "array", "description": "Assembly products. Only returned when product.type is ASSEMBLY" }, "product_listing_variants": { "items": { "$ref": "#/components/schemas/APIBaseProductListingVariant" }, "type": "array", "description": "Product listing variants" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductSupportedActionType_" }, "type": "array" }, "increment_level": { "type": "number", "format": "double", "deprecated": true }, "maximum_level": { "type": "number", "format": "double", "deprecated": true }, "minimum_level": { "type": "number", "format": "double", "deprecated": true }, "barcode": { "type": ["string", "null"], "deprecated": true } }, "required": [ "is_hazmat", "subcategory", "category", "virtual_bundle_component_count", "product_listing_variant_count", "pick_fee_override", "printed_commodity_identifier", "eccn", "manufacturer", "updated_at", "created_at", "config", "first_article_inspection_completed_at", "customs_value_currency", "customs_value", "customs_description", "country_of_origin", "hs_code", "mpn", "image_url", "measurement_unit", "height", "width", "length", "weight_unit", "weight", "cost_currency", "cost_price", "sku", "description", "type", "name", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "id", "available", "on_hand", "committed", "unavailable", "on_order", "inventory_by_warehouse", "product_listing_variants", "supported_actions", "increment_level", "maximum_level", "minimum_level", "barcode" ], "type": "object", "additionalProperties": false }, "APIPublicExpandedProduct": { "properties": { "is_hazmat": { "type": "boolean", "description": "Whether the product is classified as hazardous material" }, "subcategory": { "type": ["string", "null"], "description": "Product subcategory" }, "category": { "type": ["string", "null"], "description": "Product category" }, "virtual_bundle_component_count": { "type": "number", "format": "double", "description": "Count of virtual bundles this product is a component of (denormalized for query performance)" }, "product_listing_variant_count": { "$ref": "#/components/schemas/Partial_Record_ShopType.number__", "description": "Count of product listing variants per shop type" }, "pick_fee_override": { "type": ["number", "null"], "format": "double", "description": "Custom pick fee override for this product" }, "printed_commodity_identifier": { "type": ["string", "null"], "description": "International commodity code" }, "eccn": { "type": ["string", "null"], "description": "Export Control Classification Number" }, "manufacturer": { "type": ["string", "null"], "description": "Item manufacturer" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the product was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the product was created" }, "config": { "description": "Product-level config overrides such as replenishment levels and source strategy", "oneOf": [ { "$ref": "#/components/schemas/APIProductConfig" }, { "type": "null" } ] }, "first_article_inspection_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when first article inspection was completed" }, "customs_value_currency": { "type": "string", "description": "Currency code for customs value" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Value declared for customs" }, "customs_description": { "type": ["string", "null"], "description": "Description for customs declaration" }, "country_of_origin": { "type": ["string", "null"], "description": "Country where product was manufactured" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized System code for customs" }, "mpn": { "type": ["string", "null"], "description": "Manufacturer Part Number" }, "image_url": { "type": ["string", "null"], "description": "URL to product image" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Unit of measurement for dimensions (CM, IN)" }, "height": { "type": "number", "format": "double", "description": "Height of the product in measurement_unit" }, "width": { "type": "number", "format": "double", "description": "Width of the product in measurement_unit" }, "length": { "type": "number", "format": "double", "description": "Length of the product in measurement_unit" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Unit of measurement for weight (KG, LB)" }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight of the product in weight_unit" }, "cost_currency": { "type": "string", "description": "Currency code for cost price" }, "cost_price": { "type": ["number", "null"], "format": "double", "description": "Cost price of the product" }, "sku": { "type": ["string", "null"], "description": "Stock keeping unit identifier" }, "description": { "type": ["string", "null"], "description": "Product description" }, "type": { "$ref": "#/components/schemas/APIProductType", "description": "Type of product (STANDARD, VIRTUAL_BUNDLE, ASSEMBLY)" }, "name": { "type": "string", "description": "Name of the product" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this product" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this product" }, "id": { "type": "string", "description": "Unique identifier for the product" }, "available": { "type": "number", "format": "double", "description": "Available inventory (sum across all warehouses)" }, "on_hand": { "type": "number", "format": "double", "description": "On-hand inventory (sum across all warehouses)" }, "committed": { "type": "number", "format": "double", "description": "Committed inventory (sum across all warehouses)" }, "unavailable": { "type": "number", "format": "double", "description": "Unavailable inventory (sum across all warehouses)" }, "on_order": { "type": "number", "format": "double", "description": "On-order inventory (ordered but not yet received, sum across all warehouses)" }, "inventory_by_warehouse": { "items": { "$ref": "#/components/schemas/APIWarehouseInventoryBreakdown" }, "type": "array", "description": "Inventory breakdown by warehouse with detailed operations" }, "virtual_bundle_products": { "items": { "$ref": "#/components/schemas/APIBaseVirtualBundleComponent" }, "type": "array", "description": "Virtual bundle products. Only returned when product.type is VIRTUAL_BUNDLE" }, "assembly_products": { "items": { "$ref": "#/components/schemas/APIBaseAssemblyComponent" }, "type": "array", "description": "Assembly products. Only returned when product.type is ASSEMBLY" }, "product_listing_variants": { "items": { "$ref": "#/components/schemas/APIBaseProductListingVariant" }, "type": "array", "description": "Product listing variants" }, "increment_level": { "type": "number", "format": "double", "deprecated": true }, "maximum_level": { "type": "number", "format": "double", "deprecated": true }, "minimum_level": { "type": "number", "format": "double", "deprecated": true }, "barcode": { "type": ["string", "null"], "deprecated": true } }, "required": [ "is_hazmat", "subcategory", "category", "virtual_bundle_component_count", "product_listing_variant_count", "pick_fee_override", "printed_commodity_identifier", "eccn", "manufacturer", "updated_at", "created_at", "config", "first_article_inspection_completed_at", "customs_value_currency", "customs_value", "customs_description", "country_of_origin", "hs_code", "mpn", "image_url", "measurement_unit", "height", "width", "length", "weight_unit", "weight", "cost_currency", "cost_price", "sku", "description", "type", "name", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "id", "available", "on_hand", "committed", "unavailable", "on_order", "inventory_by_warehouse", "product_listing_variants", "increment_level", "maximum_level", "minimum_level", "barcode" ], "type": "object", "additionalProperties": false }, "APIProductBundleComponent": { "description": "Product bundle component", "properties": { "component_product_id": { "type": "string", "description": "Which product the virtual bundle component is made of" }, "component_quantity": { "type": "number", "format": "double", "description": "How many of the component product are in the virtual bundle" } }, "required": ["component_product_id", "component_quantity"], "type": "object", "additionalProperties": false }, "APIProductAssemblyComponent": { "description": "Product assembly component", "properties": { "component_product_id": { "type": "string", "description": "Which product the assembly component is made of" }, "component_quantity": { "type": "number", "format": "double", "description": "How many of the component product are in the assembly product" } }, "required": ["component_product_id", "component_quantity"], "type": "object", "additionalProperties": false }, "APIPublicCreateProductInput": { "properties": { "name": { "type": "string", "description": "Name of the product" }, "type": { "$ref": "#/components/schemas/APIProductType", "description": "Type of product (STANDARD, VIRTUAL_BUNDLE, ASSEMBLY)" }, "description": { "type": ["string", "null"], "description": "Product description" }, "sku": { "type": ["string", "null"], "description": "Stock keeping unit identifier" }, "cost_price": { "type": ["number", "null"], "format": "double", "description": "Cost price of the product" }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight of the product in weight_unit" }, "length": { "type": "number", "format": "double", "description": "Length of the product in measurement_unit" }, "width": { "type": "number", "format": "double", "description": "Width of the product in measurement_unit" }, "height": { "type": "number", "format": "double", "description": "Height of the product in measurement_unit" }, "image_base64": { "type": "string", "description": "Base64 encoded product image" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized System code for customs" }, "country_of_origin": { "type": ["string", "null"], "description": "Country where product was manufactured" }, "customs_description": { "type": ["string", "null"], "description": "Description for customs declaration" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Value declared for customs" }, "bundle_components": { "items": { "$ref": "#/components/schemas/APIProductBundleComponent" }, "type": "array", "description": "Product bundle components, used for virtual bundle products" }, "assembly_components": { "items": { "$ref": "#/components/schemas/APIProductAssemblyComponent" }, "type": "array", "description": "Product assembly components, used for assembly products" }, "owner_team_id": { "type": "string", "description": "Owner team ID - the team that owns this product (optional - defaults to caller team)" }, "config": { "$ref": "#/components/schemas/APIProductConfig", "description": "Product-level replenishment config" }, "barcode": { "type": ["string", "null"], "deprecated": true }, "minimum_level": { "type": "number", "format": "double", "deprecated": true }, "maximum_level": { "type": "number", "format": "double", "deprecated": true }, "increment_level": { "type": "number", "format": "double", "deprecated": true } }, "required": ["name", "type"], "type": "object", "additionalProperties": false }, "APIPublicUpdateProductInput": { "properties": { "name": { "type": "string", "description": "Name of the product" }, "type": { "$ref": "#/components/schemas/APIProductType", "description": "Type of product (STANDARD, VIRTUAL_BUNDLE, ASSEMBLY)" }, "description": { "type": ["string", "null"], "description": "Product description" }, "sku": { "type": ["string", "null"], "description": "Stock keeping unit identifier" }, "cost_price": { "type": ["number", "null"], "format": "double", "description": "Cost price of the product" }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight of the product in weight_unit" }, "length": { "type": "number", "format": "double", "description": "Length of the product in measurement_unit" }, "width": { "type": "number", "format": "double", "description": "Width of the product in measurement_unit" }, "height": { "type": "number", "format": "double", "description": "Height of the product in measurement_unit" }, "image_base64": { "type": "string", "description": "Base64 encoded product image" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized System code for customs" }, "country_of_origin": { "type": ["string", "null"], "description": "Country where product was manufactured" }, "customs_description": { "type": ["string", "null"], "description": "Description for customs declaration" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Value declared for customs" }, "bundle_components": { "items": { "$ref": "#/components/schemas/APIProductBundleComponent" }, "type": "array", "description": "Product bundle components, used for virtual bundle products" }, "assembly_components": { "items": { "$ref": "#/components/schemas/APIProductAssemblyComponent" }, "type": "array", "description": "Product assembly components, used for assembly products" }, "config": { "$ref": "#/components/schemas/APIProductConfig", "description": "Product-level replenishment config" }, "barcode": { "type": ["string", "null"], "deprecated": true }, "minimum_level": { "type": "number", "format": "double", "deprecated": true }, "maximum_level": { "type": "number", "format": "double", "deprecated": true }, "increment_level": { "type": "number", "format": "double", "deprecated": true } }, "type": "object", "additionalProperties": false }, "APIPublicMinimalProductWithActions": { "properties": { "is_hazmat": { "type": "boolean", "description": "Whether the product is classified as hazardous material" }, "subcategory": { "type": ["string", "null"], "description": "Product subcategory" }, "category": { "type": ["string", "null"], "description": "Product category" }, "virtual_bundle_component_count": { "type": "number", "format": "double", "description": "Count of virtual bundles this product is a component of (denormalized for query performance)" }, "product_listing_variant_count": { "$ref": "#/components/schemas/Partial_Record_ShopType.number__", "description": "Count of product listing variants per shop type" }, "pick_fee_override": { "type": ["number", "null"], "format": "double", "description": "Custom pick fee override for this product" }, "printed_commodity_identifier": { "type": ["string", "null"], "description": "International commodity code" }, "eccn": { "type": ["string", "null"], "description": "Export Control Classification Number" }, "manufacturer": { "type": ["string", "null"], "description": "Item manufacturer" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the product was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the product was created" }, "config": { "description": "Product-level config overrides such as replenishment levels and source strategy", "oneOf": [ { "$ref": "#/components/schemas/APIProductConfig" }, { "type": "null" } ] }, "first_article_inspection_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when first article inspection was completed" }, "customs_value_currency": { "type": "string", "description": "Currency code for customs value" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Value declared for customs" }, "customs_description": { "type": ["string", "null"], "description": "Description for customs declaration" }, "country_of_origin": { "type": ["string", "null"], "description": "Country where product was manufactured" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized System code for customs" }, "mpn": { "type": ["string", "null"], "description": "Manufacturer Part Number" }, "image_url": { "type": ["string", "null"], "description": "URL to product image" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Unit of measurement for dimensions (CM, IN)" }, "height": { "type": "number", "format": "double", "description": "Height of the product in measurement_unit" }, "width": { "type": "number", "format": "double", "description": "Width of the product in measurement_unit" }, "length": { "type": "number", "format": "double", "description": "Length of the product in measurement_unit" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Unit of measurement for weight (KG, LB)" }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight of the product in weight_unit" }, "cost_currency": { "type": "string", "description": "Currency code for cost price" }, "cost_price": { "type": ["number", "null"], "format": "double", "description": "Cost price of the product" }, "sku": { "type": ["string", "null"], "description": "Stock keeping unit identifier" }, "description": { "type": ["string", "null"], "description": "Product description" }, "type": { "$ref": "#/components/schemas/APIProductType", "description": "Type of product (STANDARD, VIRTUAL_BUNDLE, ASSEMBLY)" }, "name": { "type": "string", "description": "Name of the product" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this product" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this product" }, "id": { "type": "string", "description": "Unique identifier for the product" }, "available": { "type": "number", "format": "double", "description": "Available inventory (sum across all warehouses)" }, "on_hand": { "type": "number", "format": "double", "description": "On-hand inventory (sum across all warehouses)" }, "committed": { "type": "number", "format": "double", "description": "Committed inventory (sum across all warehouses)" }, "unavailable": { "type": "number", "format": "double", "description": "Unavailable inventory (sum across all warehouses)" }, "on_order": { "type": "number", "format": "double", "description": "On-order inventory (ordered but not yet received, sum across all warehouses)" }, "inventory_by_warehouse": { "items": { "$ref": "#/components/schemas/APIWarehouseInventoryBreakdown" }, "type": "array", "description": "Inventory breakdown by warehouse with detailed operations" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductSupportedActionType_" }, "type": "array" }, "increment_level": { "type": "number", "format": "double", "deprecated": true }, "maximum_level": { "type": "number", "format": "double", "deprecated": true }, "minimum_level": { "type": "number", "format": "double", "deprecated": true }, "barcode": { "type": ["string", "null"], "deprecated": true } }, "required": [ "is_hazmat", "subcategory", "category", "virtual_bundle_component_count", "product_listing_variant_count", "pick_fee_override", "printed_commodity_identifier", "eccn", "manufacturer", "updated_at", "created_at", "config", "first_article_inspection_completed_at", "customs_value_currency", "customs_value", "customs_description", "country_of_origin", "hs_code", "mpn", "image_url", "measurement_unit", "height", "width", "length", "weight_unit", "weight", "cost_currency", "cost_price", "sku", "description", "type", "name", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "id", "available", "on_hand", "committed", "unavailable", "on_order", "inventory_by_warehouse", "supported_actions", "increment_level", "maximum_level", "minimum_level", "barcode" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIPublicMinimalProductWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIPublicMinimalProductWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIPublicGetManyProductsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIPublicMinimalProductWithActions_" }, "ProductStockSupportedActionType": { "enum": [ "VIEW_PRODUCT", "VIEW_LOCATION", "VIEW_TOTE", "UPDATE_STOCK", "TRANSFER_STOCK", "BREAKBULK", "UNSTOCK_PRODUCT", "VIEW_HISTORY" ], "type": "string" }, "APISupportedAction_ProductStockSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ProductStockSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIBaseProduct": { "properties": { "is_hazmat": { "type": "boolean", "description": "Whether the product is classified as hazardous material" }, "subcategory": { "type": ["string", "null"], "description": "Product subcategory" }, "category": { "type": ["string", "null"], "description": "Product category" }, "virtual_bundle_component_count": { "type": "number", "format": "double", "description": "Count of virtual bundles this product is a component of (denormalized for query performance)" }, "product_listing_variant_count": { "$ref": "#/components/schemas/Partial_Record_ShopType.number__", "description": "Count of product listing variants per shop type" }, "pick_fee_override": { "type": ["number", "null"], "format": "double", "description": "Custom pick fee override for this product" }, "printed_commodity_identifier": { "type": ["string", "null"], "description": "International commodity code" }, "eccn": { "type": ["string", "null"], "description": "Export Control Classification Number" }, "manufacturer": { "type": ["string", "null"], "description": "Item manufacturer" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the product was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the product was created" }, "config": { "description": "Product-level config overrides such as replenishment levels and source strategy", "oneOf": [ { "$ref": "#/components/schemas/APIProductConfig" }, { "type": "null" } ] }, "first_article_inspection_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when first article inspection was completed" }, "customs_value_currency": { "type": "string", "description": "Currency code for customs value" }, "customs_value": { "type": ["number", "null"], "format": "double", "description": "Value declared for customs" }, "customs_description": { "type": ["string", "null"], "description": "Description for customs declaration" }, "country_of_origin": { "type": ["string", "null"], "description": "Country where product was manufactured" }, "hs_code": { "type": ["string", "null"], "description": "Harmonized System code for customs" }, "mpn": { "type": ["string", "null"], "description": "Manufacturer Part Number" }, "image_url": { "type": ["string", "null"], "description": "URL to product image" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Unit of measurement for dimensions (CM, IN)" }, "height": { "type": "number", "format": "double", "description": "Height of the product in measurement_unit" }, "width": { "type": "number", "format": "double", "description": "Width of the product in measurement_unit" }, "length": { "type": "number", "format": "double", "description": "Length of the product in measurement_unit" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Unit of measurement for weight (KG, LB)" }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight of the product in weight_unit" }, "cost_currency": { "type": "string", "description": "Currency code for cost price" }, "cost_price": { "type": ["number", "null"], "format": "double", "description": "Cost price of the product" }, "sku": { "type": ["string", "null"], "description": "Stock keeping unit identifier" }, "description": { "type": ["string", "null"], "description": "Product description" }, "type": { "$ref": "#/components/schemas/APIProductType", "description": "Type of product (STANDARD, VIRTUAL_BUNDLE, ASSEMBLY)" }, "name": { "type": "string", "description": "Name of the product" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this product" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this product" }, "id": { "type": "string", "description": "Unique identifier for the product" } }, "required": [ "is_hazmat", "subcategory", "category", "virtual_bundle_component_count", "product_listing_variant_count", "pick_fee_override", "printed_commodity_identifier", "eccn", "manufacturer", "updated_at", "created_at", "config", "first_article_inspection_completed_at", "customs_value_currency", "customs_value", "customs_description", "country_of_origin", "hs_code", "mpn", "image_url", "measurement_unit", "height", "width", "length", "weight_unit", "weight", "cost_currency", "cost_price", "sku", "description", "type", "name", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "id" ], "type": "object" }, "LocationWithParent": { "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" }, "parent_location": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseLocation" }, { "type": "null" } ] } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id", "parent_location" ], "type": "object", "additionalProperties": false }, "APIExpandedProductStockWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized: label (null = eaches)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized: how many eaches per UoM unit (null = eaches)" }, "uom_profile_id": { "type": ["string", "null"], "description": "Live UoM profile ID (null = eaches)" }, "location_kind": { "$ref": "#/components/schemas/LocationKind", "description": "The kind of location (denormalized for dynamic view actions)" }, "location_pickable": { "type": "boolean", "description": "Whether the location is pickable (denormalized from location for performance)" }, "location_sellable": { "type": "boolean", "description": "Whether the location is sellable (denormalized from location for performance)" }, "parent_location_name": { "type": ["string", "null"], "description": "Parent location name for LPN/TOTE display" }, "location_name": { "type": "string", "description": "Location name" }, "product_type": { "$ref": "#/components/schemas/APIProductType", "description": "Denormalized: product type (for UoM selection)" }, "image_url": { "type": ["string", "null"], "description": "Product image URL" }, "sku": { "type": ["string", "null"], "description": "Product SKU" }, "name": { "type": "string", "description": "Product name" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "team_id": { "type": "string", "deprecated": true }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns the product represented by this stock" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team that owns the warehouse/location" }, "location_id": { "type": "string", "description": "Location ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID (nullable for orphaned stock after delegation deletion)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the stock record was created" }, "received_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was physically received from supplier (for FIFO)" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date" }, "lot_code": { "type": ["string", "null"], "description": "Lot code" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was last updated" }, "on_hand": { "type": "number", "format": "double", "description": "Quantity on hand, always in base stock units (eaches)" }, "id": { "type": "string", "description": "Unique identifier" }, "product": { "description": "The product this stock belongs to with expanded data.\nNull for orphaned stock where the linked product no longer exists (e.g.\nproduct hard-deleted, or stock created by a partial sync before the\nproduct row was upserted). Mirrors the nullable product_id FK.", "oneOf": [ { "$ref": "#/components/schemas/APIBaseProduct" }, { "type": "null" } ] }, "location": { "$ref": "#/components/schemas/LocationWithParent", "description": "The location where this stock is stored with expanded data" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductStockSupportedActionType_" }, "type": "array" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "location_kind", "location_pickable", "location_sellable", "parent_location_name", "location_name", "product_type", "image_url", "sku", "name", "warehouse_name", "warehouse_id", "team_id", "merchant_team_id", "fulfiller_team_id", "location_id", "product_id", "created_at", "received_at", "expiration_date", "lot_code", "updated_at", "on_hand", "id", "product", "location", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedProductStock": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized: label (null = eaches)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized: how many eaches per UoM unit (null = eaches)" }, "uom_profile_id": { "type": ["string", "null"], "description": "Live UoM profile ID (null = eaches)" }, "location_kind": { "$ref": "#/components/schemas/LocationKind", "description": "The kind of location (denormalized for dynamic view actions)" }, "location_pickable": { "type": "boolean", "description": "Whether the location is pickable (denormalized from location for performance)" }, "location_sellable": { "type": "boolean", "description": "Whether the location is sellable (denormalized from location for performance)" }, "parent_location_name": { "type": ["string", "null"], "description": "Parent location name for LPN/TOTE display" }, "location_name": { "type": "string", "description": "Location name" }, "product_type": { "$ref": "#/components/schemas/APIProductType", "description": "Denormalized: product type (for UoM selection)" }, "image_url": { "type": ["string", "null"], "description": "Product image URL" }, "sku": { "type": ["string", "null"], "description": "Product SKU" }, "name": { "type": "string", "description": "Product name" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "team_id": { "type": "string", "deprecated": true }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns the product represented by this stock" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team that owns the warehouse/location" }, "location_id": { "type": "string", "description": "Location ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID (nullable for orphaned stock after delegation deletion)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the stock record was created" }, "received_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was physically received from supplier (for FIFO)" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date" }, "lot_code": { "type": ["string", "null"], "description": "Lot code" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was last updated" }, "on_hand": { "type": "number", "format": "double", "description": "Quantity on hand, always in base stock units (eaches)" }, "id": { "type": "string", "description": "Unique identifier" }, "product": { "description": "The product this stock belongs to with expanded data.\nNull for orphaned stock where the linked product no longer exists (e.g.\nproduct hard-deleted, or stock created by a partial sync before the\nproduct row was upserted). Mirrors the nullable product_id FK.", "oneOf": [ { "$ref": "#/components/schemas/APIBaseProduct" }, { "type": "null" } ] }, "location": { "$ref": "#/components/schemas/LocationWithParent", "description": "The location where this stock is stored with expanded data" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "location_kind", "location_pickable", "location_sellable", "parent_location_name", "location_name", "product_type", "image_url", "sku", "name", "warehouse_name", "warehouse_id", "team_id", "merchant_team_id", "fulfiller_team_id", "location_id", "product_id", "created_at", "received_at", "expiration_date", "lot_code", "updated_at", "on_hand", "id", "product", "location" ], "type": "object", "additionalProperties": false }, "ShipOSCreateProductStockInput": { "description": "Input for creating product stock", "properties": { "product_id": { "type": "string", "description": "ID of the product" }, "location_id": { "type": "string", "description": "ID of the location where stock will be stored" }, "on_hand": { "type": "number", "format": "double", "description": "Quantity to add" }, "lot_code": { "type": ["string", "null"], "description": "Lot code for batch tracking" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date for perishable items" } }, "required": ["product_id", "location_id", "on_hand"], "type": "object", "additionalProperties": false }, "ShipOSUpdateProductStockInput": { "description": "Input for updating product stock\n\nStock quantity changes use delta-based operations rather than absolute values.\nThis prevents race conditions when multiple users update stock simultaneously.", "properties": { "on_hand_delta": { "type": "number", "format": "double", "description": "Delta-based stock adjustment (race-safe).\nUse a positive number to add stock, negative to remove stock.\nCannot be zero - omit the field if no change is needed." }, "lot_code": { "type": ["string", "null"], "description": "Updated lot code" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Updated expiration date" }, "location_id": { "type": "string", "description": "New location ID (for moving stock)" }, "reason": { "type": "string", "description": "Reason for the inventory change (for audit purposes)" } }, "type": "object", "additionalProperties": false }, "ShipOSTransferProductStockInput": { "description": "Input for transferring product stock", "properties": { "destination_location_id": { "type": "string", "description": "ID of the destination location" }, "quantity": { "type": "number", "format": "double", "description": "Quantity to transfer" } }, "required": ["destination_location_id", "quantity"], "type": "object", "additionalProperties": false }, "APIMinimalProductStockWithActions": { "description": "API Product Stock with minimal data and action IDs for public API", "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized: label (null = eaches)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized: how many eaches per UoM unit (null = eaches)" }, "uom_profile_id": { "type": ["string", "null"], "description": "Live UoM profile ID (null = eaches)" }, "location_kind": { "$ref": "#/components/schemas/LocationKind", "description": "The kind of location (denormalized for dynamic view actions)" }, "location_pickable": { "type": "boolean", "description": "Whether the location is pickable (denormalized from location for performance)" }, "location_sellable": { "type": "boolean", "description": "Whether the location is sellable (denormalized from location for performance)" }, "parent_location_name": { "type": ["string", "null"], "description": "Parent location name for LPN/TOTE display" }, "location_name": { "type": "string", "description": "Location name" }, "product_type": { "$ref": "#/components/schemas/APIProductType", "description": "Denormalized: product type (for UoM selection)" }, "image_url": { "type": ["string", "null"], "description": "Product image URL" }, "sku": { "type": ["string", "null"], "description": "Product SKU" }, "name": { "type": "string", "description": "Product name" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "team_id": { "type": "string", "deprecated": true }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns the product represented by this stock" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team that owns the warehouse/location" }, "location_id": { "type": "string", "description": "Location ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID (nullable for orphaned stock after delegation deletion)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the stock record was created" }, "received_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was physically received from supplier (for FIFO)" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date" }, "lot_code": { "type": ["string", "null"], "description": "Lot code" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was last updated" }, "on_hand": { "type": "number", "format": "double", "description": "Quantity on hand, always in base stock units (eaches)" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductStockSupportedActionType_" }, "type": "array", "description": "Supported action IDs for this product stock" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "location_kind", "location_pickable", "location_sellable", "parent_location_name", "location_name", "product_type", "image_url", "sku", "name", "warehouse_name", "warehouse_id", "team_id", "merchant_team_id", "fulfiller_team_id", "location_id", "product_id", "created_at", "received_at", "expiration_date", "lot_code", "updated_at", "on_hand", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalProductStockWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalProductStockWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyProductStocksResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalProductStockWithActions_", "description": "Response type for get-many operations" }, "ProductListingSupportedActionType": { "enum": ["VIEW_REMOTE_LISTING"], "type": "string" }, "APISupportedAction_ProductListingSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ProductListingSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIProductListingStatus": { "type": "string", "enum": ["ARCHIVED", "DRAFT", "ACTIVE", "UNLISTED", "DELETED"] }, "APIExpandedProductListingWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "shop_slug": { "type": ["string", "null"], "description": "Shop slug" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this listing" }, "shop_id": { "type": "string", "description": "Shop ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "status": { "$ref": "#/components/schemas/APIProductListingStatus", "description": "Listing status" }, "slug": { "type": ["string", "null"], "description": "URL slug" }, "description": { "type": ["string", "null"], "description": "Listing description" }, "name": { "type": "string", "description": "Listing title" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "remote_id": { "type": "string", "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the listing was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the listing was created" }, "id": { "type": "string", "description": "Unique identifier" }, "product_listing_variants": { "items": { "$ref": "#/components/schemas/APIBaseProductListingVariant" }, "type": "array", "description": "Product listing variants" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductListingSupportedActionType_" }, "type": "array" } }, "required": [ "shop_slug", "shop_name", "shop_type", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "shop_id", "image_url", "status", "slug", "description", "name", "synced_at", "remote_id", "updated_at", "created_at", "id", "product_listing_variants", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIMinimalProductListingWithActions": { "description": "API Product Listing with minimal data and supported actions for public API", "properties": { "shop_slug": { "type": ["string", "null"], "description": "Shop slug" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this listing" }, "shop_id": { "type": "string", "description": "Shop ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "status": { "$ref": "#/components/schemas/APIProductListingStatus", "description": "Listing status" }, "slug": { "type": ["string", "null"], "description": "URL slug" }, "description": { "type": ["string", "null"], "description": "Listing description" }, "name": { "type": "string", "description": "Listing title" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "remote_id": { "type": "string", "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the listing was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the listing was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "shop_slug", "shop_name", "shop_type", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "shop_id", "image_url", "status", "slug", "description", "name", "synced_at", "remote_id", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalProductListingWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalProductListingWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyProductListingsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalProductListingWithActions_", "description": "Response type for get-many operations" }, "ProductListingVariantSupportedActionType": { "enum": [ "VIEW_LISTING_VARIANT", "VIEW_PRODUCT", "LINK_PRODUCT", "UNLINK_PRODUCT", "CREATE_AND_LINK_PRODUCT", "VIEW_REMOTE_LISTING_VARIANT", "VIEW_REMOTE_LISTING" ], "type": "string" }, "APISupportedAction_ProductListingVariantSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ProductListingVariantSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIBaseProductListing": { "properties": { "shop_slug": { "type": ["string", "null"], "description": "Shop slug" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this listing" }, "shop_id": { "type": "string", "description": "Shop ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "status": { "$ref": "#/components/schemas/APIProductListingStatus", "description": "Listing status" }, "slug": { "type": ["string", "null"], "description": "URL slug" }, "description": { "type": ["string", "null"], "description": "Listing description" }, "name": { "type": "string", "description": "Listing title" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "remote_id": { "type": "string", "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the listing was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the listing was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "shop_slug", "shop_name", "shop_type", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "shop_id", "image_url", "status", "slug", "description", "name", "synced_at", "remote_id", "updated_at", "created_at", "id" ], "type": "object" }, "APIExpandedProductListingVariantWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "shop_slug": { "type": ["string", "null"], "description": "Shop slug" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "remote_shopify_inventory_item_id": { "type": ["string", "null"], "description": "Remote Shopify inventory item ID" }, "shop_id": { "type": "string", "description": "Shop ID" }, "weight_unit": { "description": "Weight unit", "type": ["string", "null"], "enum": ["G", "KG", "OZ", "LB"] }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight" }, "sku": { "type": ["string", "null"], "description": "SKU" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this variant" }, "product_listing_name": { "type": "string", "description": "Product listing name (denormalized from parent ProductListing)" }, "product_listing_id": { "type": "string", "description": "Product listing ID" }, "product_type": { "description": "Product type (denormalized from linked Product)", "type": ["string", "null"], "enum": ["STANDARD", "ASSEMBLY", "VIRTUAL_BUNDLE", "DIGITAL", "UOM"] }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "country_of_origin": { "type": ["string", "null"], "description": "Country of origin" }, "currency": { "type": "string", "description": "Currency" }, "price": { "type": "number", "format": "double", "description": "Price" }, "hs_code": { "type": ["string", "null"], "description": "HS code" }, "barcode": { "type": ["string", "null"], "description": "Barcode" }, "name": { "type": "string", "description": "Variant title" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the variant was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the variant was created" }, "id": { "type": "string", "description": "Unique identifier" }, "product": { "description": "Product", "oneOf": [ { "$ref": "#/components/schemas/APIBaseProduct" }, { "type": "null" } ] }, "product_listing": { "$ref": "#/components/schemas/APIBaseProductListing", "description": "Product listing" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductListingVariantSupportedActionType_" }, "type": "array" } }, "required": [ "shop_slug", "shop_name", "shop_type", "remote_shopify_inventory_item_id", "shop_id", "weight_unit", "weight", "sku", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "product_listing_name", "product_listing_id", "product_type", "product_id", "image_url", "country_of_origin", "currency", "price", "hs_code", "barcode", "name", "synced_at", "remote_id", "updated_at", "created_at", "id", "product", "product_listing", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIMinimalProductListingVariantWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "shop_slug": { "type": ["string", "null"], "description": "Shop slug" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type" }, "remote_shopify_inventory_item_id": { "type": ["string", "null"], "description": "Remote Shopify inventory item ID" }, "shop_id": { "type": "string", "description": "Shop ID" }, "weight_unit": { "description": "Weight unit", "type": ["string", "null"], "enum": ["G", "KG", "OZ", "LB"] }, "weight": { "type": ["number", "null"], "format": "double", "description": "Weight" }, "sku": { "type": ["string", "null"], "description": "SKU" }, "team_name": { "type": "string", "deprecated": true }, "team_id": { "type": "string", "deprecated": true }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this variant" }, "product_listing_name": { "type": "string", "description": "Product listing name (denormalized from parent ProductListing)" }, "product_listing_id": { "type": "string", "description": "Product listing ID" }, "product_type": { "description": "Product type (denormalized from linked Product)", "type": ["string", "null"], "enum": ["STANDARD", "ASSEMBLY", "VIRTUAL_BUNDLE", "DIGITAL", "UOM"] }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "country_of_origin": { "type": ["string", "null"], "description": "Country of origin" }, "currency": { "type": "string", "description": "Currency" }, "price": { "type": "number", "format": "double", "description": "Price" }, "hs_code": { "type": ["string", "null"], "description": "HS code" }, "barcode": { "type": ["string", "null"], "description": "Barcode" }, "name": { "type": "string", "description": "Variant title" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the variant was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the variant was created" }, "id": { "type": "string", "description": "Unique identifier" }, "product": { "description": "Product", "oneOf": [ { "$ref": "#/components/schemas/APIBaseProduct" }, { "type": "null" } ] }, "product_listing": { "$ref": "#/components/schemas/APIBaseProductListing", "description": "Product listing" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductListingVariantSupportedActionType_" }, "type": "array" } }, "required": [ "shop_slug", "shop_name", "shop_type", "remote_shopify_inventory_item_id", "shop_id", "weight_unit", "weight", "sku", "team_name", "team_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "product_listing_name", "product_listing_id", "product_type", "product_id", "image_url", "country_of_origin", "currency", "price", "hs_code", "barcode", "name", "synced_at", "remote_id", "updated_at", "created_at", "id", "product", "product_listing", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalProductListingVariantWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalProductListingVariantWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyProductListingVariantsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalProductListingVariantWithActions_", "description": "Response type for get-many operations" }, "APIPickingSessionStatus": { "type": "string", "enum": ["UNASSIGNED", "ASSIGNED", "IN_PROGRESS", "CLOSED"] }, "APIPickingSessionCreationMode": { "type": "string", "enum": ["DIRECT", "WAVE"] }, "APIPickingSessionResponse": { "description": "Standard response for picking session creation/duplication", "properties": { "id": { "type": "string" }, "status": { "$ref": "#/components/schemas/APIPickingSessionStatus" }, "creation_mode": { "$ref": "#/components/schemas/APIPickingSessionCreationMode" } }, "required": ["id", "status", "creation_mode"], "type": "object", "additionalProperties": false }, "APICreateSingleOrderInput": { "description": "Input for the dedicated /single-order route\nDoes not include type since the route itself defines it", "properties": { "warehouse_id": { "type": "string" }, "fulfillment_order_id": { "type": "string" } }, "required": ["warehouse_id", "fulfillment_order_id"], "type": "object", "additionalProperties": false }, "APICreateMultiItemBatchInput": { "description": "Input for the dedicated /multi-item-batch route\nDoes not include type since the route itself defines it", "properties": { "warehouse_id": { "type": "string" }, "bins": { "type": "number", "format": "double" }, "merchant_team_ids": { "items": { "type": "string" }, "type": "array" }, "max_units_per_order": { "type": ["number", "null"], "format": "double" }, "min_units_per_order": { "type": ["number", "null"], "format": "double" } }, "required": ["warehouse_id", "bins"], "type": "object", "additionalProperties": false }, "AllocationSummary": { "description": "Allocation summary for BY_FULFILLMENT_ORDER_IDS picking sessions", "properties": { "total_requested": { "type": "number", "format": "double" }, "total_succeeded": { "type": "number", "format": "double" }, "total_failed": { "type": "number", "format": "double" }, "partial_success": { "type": "boolean" } }, "required": ["total_requested", "total_succeeded", "total_failed", "partial_success"], "type": "object", "additionalProperties": false }, "SuccessfulOrderAllocation": { "description": "Detailed information about a successfully allocated order", "properties": { "fulfillment_order_id": { "type": "string" }, "order_number": { "type": "string" }, "shop_name": { "type": "string" }, "total_units": { "type": "number", "format": "double" }, "line_items_count": { "type": "number", "format": "double" } }, "required": ["fulfillment_order_id", "order_number", "shop_name", "total_units", "line_items_count"], "type": "object", "additionalProperties": false }, "PickingSessionOrderFailureCategory": { "description": "Failure categories for picking session order allocation", "enum": [ "CUSTOM_PRODUCTS", "LOCKED", "INSUFFICIENT_INVENTORY", "NEEDS_UOM_BREAK", "UOM_ALLOCATION_COMPLEXITY", "NOT_FOUND", "WRONG_WAREHOUSE" ], "type": "string" }, "MissingProduct": { "description": "Missing product details for inventory failures", "properties": { "product_id": { "type": "string" }, "sku": { "type": "string" }, "name": { "type": "string" }, "required": { "type": "number", "format": "double" }, "available": { "type": "number", "format": "double" } }, "required": ["product_id", "sku", "name", "required", "available"], "type": "object", "additionalProperties": false }, "FailureDetails": { "description": "Detailed failure information for order allocation", "properties": { "locked_by": { "type": ["string", "null"] }, "lock_display_name": { "type": ["string", "null"] }, "lock_type": { "type": ["string", "null"] }, "required_quantity": { "type": ["number", "null"], "format": "double" }, "available_quantity": { "type": ["number", "null"], "format": "double" }, "missing_products": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/MissingProduct" } }, "custom_line_items_count": { "type": ["number", "null"], "format": "double" }, "assigned_warehouse_id": { "type": ["string", "null"] }, "assigned_warehouse_name": { "type": ["string", "null"] } }, "required": [ "locked_by", "lock_display_name", "lock_type", "required_quantity", "available_quantity", "missing_products", "custom_line_items_count", "assigned_warehouse_id", "assigned_warehouse_name" ], "type": "object", "additionalProperties": false }, "FailedOrderAllocation": { "description": "Detailed information about a failed order allocation", "properties": { "fulfillment_order_id": { "type": "string" }, "order_number": { "type": "string" }, "shop_name": { "type": "string" }, "failure_category": { "$ref": "#/components/schemas/PickingSessionOrderFailureCategory" }, "failure_reason": { "type": "string" }, "failure_details": { "$ref": "#/components/schemas/FailureDetails" }, "actionable_suggestion": { "type": "string" } }, "required": [ "fulfillment_order_id", "order_number", "shop_name", "failure_category", "failure_reason", "failure_details", "actionable_suggestion" ], "type": "object", "additionalProperties": false }, "AllocationResults": { "description": "Detailed allocation results for BY_FULFILLMENT_ORDER_IDS picking sessions", "properties": { "allocation_summary": { "$ref": "#/components/schemas/AllocationSummary" }, "successful_orders": { "items": { "$ref": "#/components/schemas/SuccessfulOrderAllocation" }, "type": "array" }, "failed_orders": { "items": { "$ref": "#/components/schemas/FailedOrderAllocation" }, "type": "array" } }, "required": ["allocation_summary", "successful_orders", "failed_orders"], "type": "object", "additionalProperties": false }, "APIByFulfillmentOrderIdsPickingSessionResponse": { "description": "Enhanced response for BY_FULFILLMENT_ORDER_IDS picking session creation\nIncludes detailed allocation results showing which orders succeeded and which failed", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "bins": { "type": "number", "format": "double" }, "warehouse_id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "allocation_results": { "$ref": "#/components/schemas/AllocationResults" } }, "required": ["id", "status", "bins", "warehouse_id", "created_at", "allocation_results"], "type": "object", "additionalProperties": false }, "APICreateByFulfillmentOrderIdsInput": { "description": "Input for the dedicated /by-fulfillment-order-ids route\nDoes not include type since the route itself defines it", "properties": { "warehouse_id": { "type": "string" }, "fulfillment_order_ids": { "items": { "type": "string" }, "type": "array" } }, "required": ["warehouse_id", "fulfillment_order_ids"], "type": "object", "additionalProperties": false }, "APIPickingSessionMetrics": { "description": "API interface for picking session performance metrics", "properties": { "total_time_to_pick": { "type": "number", "format": "double" }, "total_time_to_pick_formatted": { "type": "string" }, "orders_per_hour": { "type": ["number", "null"], "format": "double" }, "lines_per_hour": { "type": ["number", "null"], "format": "double" }, "eaches_per_hour": { "type": ["number", "null"], "format": "double" }, "total_items_picked": { "type": "number", "format": "double" }, "total_orders": { "type": "number", "format": "double" }, "total_lines": { "type": "number", "format": "double" }, "started_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": "string", "format": "date-time" } }, "required": [ "total_time_to_pick", "total_time_to_pick_formatted", "orders_per_hour", "lines_per_hour", "eaches_per_hour", "total_items_picked", "total_orders", "total_lines", "started_at", "closed_at" ], "type": "object", "additionalProperties": false }, "PickingSessionCompletionOutcome": { "type": "string", "enum": ["FULLY_PICKED", "WITH_EXCEPTIONS"] }, "PickingSessionType": { "type": "string", "enum": ["SINGLE_ITEM_BATCH", "MULTI_ITEM_BATCH", "SINGLE_ORDER", "BULK_BATCH"] }, "APIExpandedPickingSession": { "description": "API type for GET operations with basic picking session details\nFor full nested data including line items and allocations, use getInternal endpoint", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time the picking session was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session was last updated" }, "status": { "$ref": "#/components/schemas/APIPickingSessionStatus", "description": "Status of the picking session" }, "completion_outcome": { "description": "Why the session closed. Null while active.", "type": ["string", "null"], "enum": ["FULLY_PICKED", "WITH_EXCEPTIONS"] }, "max_units_per_order": { "type": ["number", "null"], "format": "double", "description": "Maximum units per order" }, "bins": { "type": "number", "format": "double", "description": "Bins" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "merchant_team_id": { "items": { "type": "string" }, "type": "array", "description": "Merchant team ID" }, "started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session was started. Null if not yet started (UNASSIGNED/ASSIGNED)." }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session was closed" }, "id": { "type": "string", "description": "ID of the picking session" }, "min_units_per_order": { "type": ["number", "null"], "format": "double", "description": "Minimum units per order" }, "team_id": { "type": "string", "description": "Team ID" }, "type": { "$ref": "#/components/schemas/PickingSessionType", "description": "Type of the picking session" }, "creation_mode": { "$ref": "#/components/schemas/APIPickingSessionCreationMode", "description": "How fulfillment orders were selected when this session was created" }, "picked_by_user_id": { "type": ["string", "null"], "description": "User ID of the picker assigned to this session" }, "picked_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the picker assigned to this session" }, "session_number": { "type": "string", "description": "Human-readable session number, auto-incremented per team" }, "total_units_count": { "type": "number", "format": "double", "description": "Denormalized total units count across all allocations" }, "unique_items_count": { "type": "number", "format": "double", "description": "Denormalized count of unique products/items" }, "remaining_units_to_pick": { "type": "number", "format": "double", "description": "Denormalized remaining units left to pick, decremented on each pick" }, "picking_session_fulfillment_orders": { "items": { "$ref": "#/components/schemas/APIBasePickingSessionFulfillmentOrder" }, "type": "array" }, "metrics": { "oneOf": [ { "$ref": "#/components/schemas/APIPickingSessionMetrics" }, { "type": "null" } ] } }, "required": [ "created_at", "updated_at", "status", "completion_outcome", "max_units_per_order", "bins", "warehouse_id", "merchant_team_id", "started_at", "closed_at", "id", "min_units_per_order", "team_id", "type", "creation_mode", "picked_by_user_id", "picked_by_user_name", "session_number", "total_units_count", "unique_items_count", "remaining_units_to_pick", "picking_session_fulfillment_orders", "metrics" ], "type": "object", "additionalProperties": false }, "APIMinimalPickingSession": { "description": "Minimal picking session type for list views", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time the picking session was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session was last updated" }, "status": { "$ref": "#/components/schemas/APIPickingSessionStatus", "description": "Status of the picking session" }, "completion_outcome": { "description": "Why the session closed. Null while active.", "type": ["string", "null"], "enum": ["FULLY_PICKED", "WITH_EXCEPTIONS"] }, "max_units_per_order": { "type": ["number", "null"], "format": "double", "description": "Maximum units per order" }, "bins": { "type": "number", "format": "double", "description": "Bins" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "merchant_team_id": { "items": { "type": "string" }, "type": "array", "description": "Merchant team ID" }, "started_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session was started. Null if not yet started (UNASSIGNED/ASSIGNED)." }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session was closed" }, "id": { "type": "string", "description": "ID of the picking session" }, "min_units_per_order": { "type": ["number", "null"], "format": "double", "description": "Minimum units per order" }, "team_id": { "type": "string", "description": "Team ID" }, "type": { "$ref": "#/components/schemas/PickingSessionType", "description": "Type of the picking session" }, "creation_mode": { "$ref": "#/components/schemas/APIPickingSessionCreationMode", "description": "How fulfillment orders were selected when this session was created" }, "picked_by_user_id": { "type": ["string", "null"], "description": "User ID of the picker assigned to this session" }, "picked_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the picker assigned to this session" }, "session_number": { "type": "string", "description": "Human-readable session number, auto-incremented per team" }, "total_units_count": { "type": "number", "format": "double", "description": "Denormalized total units count across all allocations" }, "unique_items_count": { "type": "number", "format": "double", "description": "Denormalized count of unique products/items" }, "remaining_units_to_pick": { "type": "number", "format": "double", "description": "Denormalized remaining units left to pick, decremented on each pick" }, "picking_session_fulfillment_orders_count": { "type": "number", "format": "double", "description": "Count of fulfillment orders in the picking session" } }, "required": [ "created_at", "updated_at", "status", "completion_outcome", "max_units_per_order", "bins", "warehouse_id", "merchant_team_id", "started_at", "closed_at", "id", "min_units_per_order", "team_id", "type", "creation_mode", "picked_by_user_id", "picked_by_user_name", "session_number", "total_units_count", "unique_items_count", "remaining_units_to_pick", "picking_session_fulfillment_orders_count" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalPickingSession_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalPickingSession" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyPickingSessionsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalPickingSession_", "description": "Response type for get-many operations" }, "APIMinimalPickingSessionFulfillmentOrder": { "description": "API PickingSessionFulfillmentOrder with minimal data for public API", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time the picking session fulfillment order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session fulfillment order was last updated" }, "status": { "$ref": "#/components/schemas/APIPickingSessionFulfillmentOrderStatus", "description": "Status of the picking session fulfillment order" }, "fulfillment_order_id": { "type": "string", "description": "ID of the fulfillment order" }, "tote_id": { "type": ["string", "null"], "description": "ID of the tote" }, "tote_name": { "type": ["string", "null"], "description": "Name of the tote (denormalized for historical accuracy)" }, "picking_session_id": { "type": "string", "description": "ID of the picking session" }, "order_number": { "type": "string", "description": "Order number" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "When packing started (tote was scanned)" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When packing completed (order was fulfilled)" }, "packed_by_user_id": { "type": ["string", "null"], "description": "ID of the user who packed this order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who packed this order" } }, "required": [ "created_at", "updated_at", "status", "fulfillment_order_id", "tote_id", "tote_name", "picking_session_id", "order_number", "packing_started_at", "packing_completed_at", "packed_by_user_id", "packed_by_user_name" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalPickingSessionFulfillmentOrder_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalPickingSessionFulfillmentOrder" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "PickingSessionFulfillmentOrderStatus": { "type": "string", "enum": ["PENDING", "FULFILLED"] }, "APIBasePickingSessionFulfillmentOrderLineItemAllocation": { "properties": { "picking_session_fulfillment_order_line_item_id": { "type": "string", "description": "Picking session fulfillment order line item ID" }, "location_name": { "type": "string", "description": "Denormalized location name" }, "location_id": { "type": ["string", "null"], "description": "Location ID this allocation picked from (null after the location is deleted)" }, "product_stock_id": { "type": ["string", "null"], "description": "Product stock ID (null when fully picked — stock reference cleared by trigger)" }, "product_id": { "type": "string", "description": "Product ID" }, "remaining_quantity": { "type": "number", "format": "double", "description": "Remaining quantity to pick" }, "total_quantity": { "type": "number", "format": "double", "description": "Total quantity allocated" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the allocation was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the allocation was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "picking_session_fulfillment_order_line_item_id", "location_name", "location_id", "product_stock_id", "product_id", "remaining_quantity", "total_quantity", "updated_at", "created_at", "id" ], "type": "object" }, "APIExpandedPickingSessionFulfillmentOrderLineItem": { "description": "API type for expanded line item with relations (product fields are denormalized on the line item)", "properties": { "picking_session_id": { "type": "string", "description": "Picking session ID" }, "product_id": { "type": "string", "description": "Product ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "core_fulfillment_order_line_item_id": { "type": "string", "description": "Core fulfillment order line item ID" }, "image_url": { "type": ["string", "null"], "description": "Product image URL (denormalized for historical accuracy)" }, "sku": { "type": ["string", "null"], "description": "Product SKU (denormalized for historical accuracy)" }, "name": { "type": "string", "description": "Product name (denormalized for historical accuracy)" }, "unpacked_quantity": { "type": "number", "format": "double", "description": "Unpacked quantity" }, "total_quantity": { "type": "number", "format": "double", "description": "Total quantity" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "id": { "type": "string", "description": "Unique identifier" }, "picking_session_fulfillment_order_line_item_allocations": { "items": { "$ref": "#/components/schemas/APIBasePickingSessionFulfillmentOrderLineItemAllocation" }, "type": "array" } }, "required": [ "picking_session_id", "product_id", "fulfillment_order_id", "core_fulfillment_order_line_item_id", "image_url", "sku", "name", "unpacked_quantity", "total_quantity", "updated_at", "created_at", "id", "picking_session_fulfillment_order_line_item_allocations" ], "type": "object", "additionalProperties": false }, "APIExpandedPickingSessionFulfillmentOrder": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date and time the picking session fulfillment order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the picking session fulfillment order was last updated" }, "status": { "$ref": "#/components/schemas/APIPickingSessionFulfillmentOrderStatus", "description": "Status of the picking session fulfillment order" }, "fulfillment_order_id": { "type": "string", "description": "ID of the fulfillment order" }, "tote_id": { "type": ["string", "null"], "description": "ID of the tote" }, "tote_name": { "type": ["string", "null"], "description": "Name of the tote (denormalized for historical accuracy)" }, "picking_session_id": { "type": "string", "description": "ID of the picking session" }, "order_number": { "type": "string", "description": "Order number" }, "packing_started_at": { "type": ["string", "null"], "format": "date-time", "description": "When packing started (tote was scanned)" }, "packing_completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When packing completed (order was fulfilled)" }, "packed_by_user_id": { "type": ["string", "null"], "description": "ID of the user who packed this order" }, "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who packed this order" }, "picking_session_fulfillment_order_line_items": { "items": { "$ref": "#/components/schemas/APIExpandedPickingSessionFulfillmentOrderLineItem" }, "type": "array" } }, "required": [ "created_at", "updated_at", "status", "fulfillment_order_id", "tote_id", "tote_name", "picking_session_id", "order_number", "packing_started_at", "packing_completed_at", "packed_by_user_id", "packed_by_user_name", "picking_session_fulfillment_order_line_items" ], "type": "object", "additionalProperties": false }, "PackageSupportedActionType": { "enum": [ "VIEW_PACKAGE", "UPDATE_PACKAGE", "DELETE_PACKAGE", "BUY_LABEL", "GENERATE_PACKING_LIST", "GENERATE_DOCUMENTS" ], "type": "string" }, "APISupportedAction_PackageSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/PackageSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIFulfillmentStatus": { "type": "string", "enum": ["PENDING", "OPEN", "SUCCESS", "CANCELLED", "ERROR", "FAILURE"] }, "APIFulfillmentShipmentStatus": { "type": "string", "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "APIFulfillmentType": { "type": "string", "enum": ["PICK_PACK", "BULK_SHIP", "MANUAL", "API"] }, "APIBaseFulfillment": { "properties": { "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who packed the order (null for non-pick-and-pack)" }, "packed_by_user_id": { "type": ["string", "null"], "description": "Denormalized: ID of the user who packed the order (null for non-pick-and-pack)" }, "picked_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who picked the order (null for non-pick-and-pack)" }, "picked_by_user_id": { "type": ["string", "null"], "description": "Denormalized: ID of the user who picked the order (null for non-pick-and-pack)" }, "has_packshots": { "type": "boolean", "description": "Whether the fulfillment's package has packshot photos" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview (denormalized for performance)" }, "unique_core_item_count": { "type": "number", "format": "double", "description": "Unique count of core line items by product/sku/name (denormalized for list performance)" }, "total_core_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of core line items (denormalized for list performance)" }, "carton_name": { "type": ["string", "null"], "description": "Carton name (denormalized)" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID (denormalized)" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID (denormalized)" }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID (denormalized)" }, "package_type": { "description": "Package type (denormalized)", "type": ["string", "null"], "enum": ["FULFILLMENT_ORDER", "WORK_ORDER", "STANDALONE", "RETURN"] }, "shipping_label_label_url": { "type": ["string", "null"], "description": "Shipping label label URL (denormalized)" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Shipping label tracking URL (denormalized)" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "package_id": { "type": "string", "description": "Package ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID this fulfillment belongs to" }, "shop_name": { "type": ["string", "null"], "description": "Shop name" }, "shop_id": { "type": ["string", "null"], "description": "Shop ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID for the fulfillment" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (e.g., \"USPS / Priority Mail\")" }, "tracking_code": { "type": ["string", "null"], "description": "Tracking code for the fulfillment" }, "type": { "$ref": "#/components/schemas/APIFulfillmentType", "description": "Fulfillment type" }, "shipment_status": { "$ref": "#/components/schemas/APIFulfillmentShipmentStatus", "description": "Shipment status" }, "status": { "$ref": "#/components/schemas/APIFulfillmentStatus", "description": "Fulfillment status" }, "name": { "type": ["string", "null"], "description": "Formatted name" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was synced" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the fulfillment was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the fulfillment was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "packed_by_user_name", "packed_by_user_id", "picked_by_user_name", "picked_by_user_id", "has_packshots", "line_item_image_urls", "unique_core_item_count", "total_core_item_quantity", "carton_name", "carton_id", "bulk_ship_id", "picking_session_id", "package_type", "shipping_label_label_url", "shipping_label_tracking_url", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "package_id", "fulfillment_order_id", "warehouse_name", "warehouse_id", "order_id", "shop_name", "shop_id", "shipping_label_id", "formatted_service", "tracking_code", "type", "shipment_status", "status", "name", "remote_id", "synced_at", "updated_at", "created_at", "id" ], "type": "object" }, "APIPublicExpandedPackageWithActions": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "idempotency_key": { "type": ["string", "null"], "description": "Stable package identity used to reconcile unsaved packing state" }, "created_at": { "type": "string", "format": "date-time", "description": "When the package was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was last updated" }, "name": { "type": "string", "description": "Package name" }, "manifested_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was manifested" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was shipped" }, "status": { "$ref": "#/components/schemas/APIPackageStatus", "description": "Package status" }, "packing_slip_url": { "type": ["string", "null"], "description": "Packing slip URL" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit" }, "type": { "$ref": "#/components/schemas/APIPackageType", "description": "Type" }, "length": { "type": "number", "format": "double", "description": "Length" }, "width": { "type": "number", "format": "double", "description": "Width" }, "height": { "type": "number", "format": "double", "description": "Height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Weight" }, "total_customs_value": { "type": ["number", "null"], "format": "double", "description": "Total customs value" }, "config": { "description": "Package-level shipping config overrides using PackageConfigSchema", "oneOf": [ { "$ref": "#/components/schemas/APIPackageConfig" }, { "type": "null" } ] }, "rate_error_data": { "description": "Structured rate error data", "oneOf": [ { "$ref": "#/components/schemas/APILabelPurchaseError" }, { "type": "null" } ] }, "error_message": { "type": ["string", "null"], "description": "Error message" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "provider_rate_id": { "type": ["string", "null"], "description": "Exact selected provider rate, when available." }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID - when present, creates `FULFILLMENT_ORDER` package with automatic address fallbacks" }, "work_order_id": { "type": ["string", "null"], "description": "Work order ID - when present (without fulfillment_order_id), creates `WORK_ORDER` package" }, "return_id": { "type": ["string", "null"], "description": "Return ID - when present, creates `RETURN` package" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID" }, "scan_form_id": { "type": ["string", "null"], "description": "Scan form ID" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carton_name": { "type": ["string", "null"], "description": "Carton name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "bulk_ship_template_package_id": { "type": ["string", "null"], "description": "Bulk ship template package ID" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse ID" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_address1": { "type": ["string", "null"], "description": "From address street 1" }, "from_address_address2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address ZIP" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_email": { "type": ["string", "null"], "description": "From address email" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_address1": { "type": ["string", "null"], "description": "To address street 1" }, "to_address_address2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address ZIP" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_email": { "type": ["string", "null"], "description": "To address email" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the shipment should be delivered (denormalized from FulfillmentOrder)" }, "line_item_hash": { "type": "string", "description": "Hash of line items for deduplication/matching" }, "total_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of all line items" }, "unique_line_item_count": { "type": "number", "format": "double", "description": "Number of unique line items" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string for the requested carrier/service (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "shipping_label_tracking_code": { "type": ["string", "null"], "description": "Tracking code from shipping label" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Tracking URL from shipping label" }, "shipping_label_formatted_service": { "type": ["string", "null"], "description": "Formatted service display string from shipping label (what was actually bought)" }, "shipping_label_url": { "type": ["string", "null"], "description": "Label URL from shipping label" }, "shipment_status": { "description": "Shipment status from shipping label", "type": ["string", "null"], "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "package_line_items": { "items": { "$ref": "#/components/schemas/APIBasePackageLineItem" }, "type": "array", "description": "Package line items with product information" }, "fulfillment": { "description": "Fulfillment", "oneOf": [ { "$ref": "#/components/schemas/APIBaseFulfillment" }, { "type": "null" } ] }, "shipping_label": { "description": "Shipping label", "oneOf": [ { "$ref": "#/components/schemas/APIBaseShippingLabel" }, { "type": "null" } ] }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_PackageSupportedActionType_" }, "type": "array" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "idempotency_key", "created_at", "updated_at", "name", "manifested_at", "shipped_at", "status", "packing_slip_url", "measurement_unit", "type", "length", "width", "height", "weight_unit", "weight", "total_customs_value", "config", "rate_error_data", "error_message", "carrier_id", "service_id", "picking_session_id", "fulfillment_order_id", "work_order_id", "return_id", "carton_id", "shipping_label_id", "scan_form_id", "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "carton_name", "fulfiller_team_id", "fulfiller_team_name", "bulk_ship_id", "bulk_ship_template_package_id", "warehouse_id", "warehouse_name", "merchant_team_id", "merchant_team_name", "from_address_name", "from_address_company", "from_address_address1", "from_address_address2", "from_address_city", "from_address_state", "from_address_country", "from_address_zip", "from_address_phone", "from_address_email", "to_address_name", "to_address_company", "to_address_address1", "to_address_address2", "to_address_city", "to_address_state", "to_address_country", "to_address_zip", "to_address_phone", "to_address_email", "rate_shop_id", "rate_shop_name", "deliver_by", "line_item_hash", "total_item_quantity", "unique_line_item_count", "formatted_service", "shipping_label_tracking_code", "shipping_label_tracking_url", "shipping_label_formatted_service", "shipping_label_url", "shipment_status", "package_line_items", "fulfillment", "shipping_label", "supported_actions", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIPublicExpandedPackage": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "idempotency_key": { "type": ["string", "null"], "description": "Stable package identity used to reconcile unsaved packing state" }, "created_at": { "type": "string", "format": "date-time", "description": "When the package was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was last updated" }, "name": { "type": "string", "description": "Package name" }, "manifested_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was manifested" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was shipped" }, "status": { "$ref": "#/components/schemas/APIPackageStatus", "description": "Package status" }, "packing_slip_url": { "type": ["string", "null"], "description": "Packing slip URL" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit" }, "type": { "$ref": "#/components/schemas/APIPackageType", "description": "Type" }, "length": { "type": "number", "format": "double", "description": "Length" }, "width": { "type": "number", "format": "double", "description": "Width" }, "height": { "type": "number", "format": "double", "description": "Height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Weight" }, "total_customs_value": { "type": ["number", "null"], "format": "double", "description": "Total customs value" }, "config": { "description": "Package-level shipping config overrides using PackageConfigSchema", "oneOf": [ { "$ref": "#/components/schemas/APIPackageConfig" }, { "type": "null" } ] }, "rate_error_data": { "description": "Structured rate error data", "oneOf": [ { "$ref": "#/components/schemas/APILabelPurchaseError" }, { "type": "null" } ] }, "error_message": { "type": ["string", "null"], "description": "Error message" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "provider_rate_id": { "type": ["string", "null"], "description": "Exact selected provider rate, when available." }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID - when present, creates `FULFILLMENT_ORDER` package with automatic address fallbacks" }, "work_order_id": { "type": ["string", "null"], "description": "Work order ID - when present (without fulfillment_order_id), creates `WORK_ORDER` package" }, "return_id": { "type": ["string", "null"], "description": "Return ID - when present, creates `RETURN` package" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID" }, "scan_form_id": { "type": ["string", "null"], "description": "Scan form ID" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carton_name": { "type": ["string", "null"], "description": "Carton name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "bulk_ship_template_package_id": { "type": ["string", "null"], "description": "Bulk ship template package ID" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse ID" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_address1": { "type": ["string", "null"], "description": "From address street 1" }, "from_address_address2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address ZIP" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_email": { "type": ["string", "null"], "description": "From address email" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_address1": { "type": ["string", "null"], "description": "To address street 1" }, "to_address_address2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address ZIP" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_email": { "type": ["string", "null"], "description": "To address email" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the shipment should be delivered (denormalized from FulfillmentOrder)" }, "line_item_hash": { "type": "string", "description": "Hash of line items for deduplication/matching" }, "total_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of all line items" }, "unique_line_item_count": { "type": "number", "format": "double", "description": "Number of unique line items" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string for the requested carrier/service (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "shipping_label_tracking_code": { "type": ["string", "null"], "description": "Tracking code from shipping label" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Tracking URL from shipping label" }, "shipping_label_formatted_service": { "type": ["string", "null"], "description": "Formatted service display string from shipping label (what was actually bought)" }, "shipping_label_url": { "type": ["string", "null"], "description": "Label URL from shipping label" }, "shipment_status": { "description": "Shipment status from shipping label", "type": ["string", "null"], "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "package_line_items": { "items": { "$ref": "#/components/schemas/APIBasePackageLineItem" }, "type": "array", "description": "Package line items with product information" }, "fulfillment": { "description": "Fulfillment", "oneOf": [ { "$ref": "#/components/schemas/APIBaseFulfillment" }, { "type": "null" } ] }, "shipping_label": { "description": "Shipping label", "oneOf": [ { "$ref": "#/components/schemas/APIBaseShippingLabel" }, { "type": "null" } ] }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "idempotency_key", "created_at", "updated_at", "name", "manifested_at", "shipped_at", "status", "packing_slip_url", "measurement_unit", "type", "length", "width", "height", "weight_unit", "weight", "total_customs_value", "config", "rate_error_data", "error_message", "carrier_id", "service_id", "picking_session_id", "fulfillment_order_id", "work_order_id", "return_id", "carton_id", "shipping_label_id", "scan_form_id", "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "carton_name", "fulfiller_team_id", "fulfiller_team_name", "bulk_ship_id", "bulk_ship_template_package_id", "warehouse_id", "warehouse_name", "merchant_team_id", "merchant_team_name", "from_address_name", "from_address_company", "from_address_address1", "from_address_address2", "from_address_city", "from_address_state", "from_address_country", "from_address_zip", "from_address_phone", "from_address_email", "to_address_name", "to_address_company", "to_address_address1", "to_address_address2", "to_address_city", "to_address_state", "to_address_country", "to_address_zip", "to_address_phone", "to_address_email", "rate_shop_id", "rate_shop_name", "deliver_by", "line_item_hash", "total_item_quantity", "unique_line_item_count", "formatted_service", "shipping_label_tracking_code", "shipping_label_tracking_url", "shipping_label_formatted_service", "shipping_label_url", "shipment_status", "package_line_items", "fulfillment", "shipping_label", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APICreatePackageLineItemInput": { "properties": { "name": { "type": ["string", "null"] }, "sku": { "type": ["string", "null"] }, "image_url": { "type": ["string", "null"] }, "product_id": { "type": ["string", "null"] }, "quantity": { "type": "number", "format": "double" }, "core_fulfillment_order_line_item_id": { "type": ["string", "null"] }, "lot_code": { "type": ["string", "null"] }, "expiration_date": { "type": ["string", "null"], "format": "date-time" } }, "required": ["quantity"], "type": "object", "additionalProperties": false }, "APIPublicCreatePackageInput": { "properties": { "name": { "type": "string" }, "fulfillment_order_id": { "type": ["string", "null"] }, "fulfiller_team_id": { "type": "string" }, "warehouse_id": { "type": ["string", "null"] }, "merchant_team_id": { "type": ["string", "null"] }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit" }, "weight": { "type": "number", "format": "double" }, "total_customs_value": { "type": ["number", "null"], "format": "double" }, "carrier_id": { "type": ["string", "null"] }, "service_id": { "type": ["string", "null"] }, "provider_rate_id": { "type": ["string", "null"] }, "carton_id": { "type": ["string", "null"] }, "carrier_integration_id": { "type": ["string", "null"] }, "package_line_items": { "items": { "$ref": "#/components/schemas/APICreatePackageLineItemInput" }, "type": "array" }, "config": { "$ref": "#/components/schemas/APIPackageConfigInput" }, "from_address_name": { "type": ["string", "null"] }, "from_address_company": { "type": ["string", "null"] }, "from_address_address1": { "type": ["string", "null"] }, "from_address_address2": { "type": ["string", "null"] }, "from_address_city": { "type": ["string", "null"] }, "from_address_state": { "type": ["string", "null"] }, "from_address_zip": { "type": ["string", "null"] }, "from_address_country": { "type": ["string", "null"] }, "from_address_phone": { "type": ["string", "null"] }, "from_address_email": { "type": ["string", "null"] }, "to_address_name": { "type": ["string", "null"] }, "to_address_company": { "type": ["string", "null"] }, "to_address_address1": { "type": ["string", "null"] }, "to_address_address2": { "type": ["string", "null"] }, "to_address_city": { "type": ["string", "null"] }, "to_address_state": { "type": ["string", "null"] }, "to_address_zip": { "type": ["string", "null"] }, "to_address_country": { "type": ["string", "null"] }, "to_address_phone": { "type": ["string", "null"] }, "to_address_email": { "type": ["string", "null"] }, "package_preset_id": { "type": ["string", "null"], "deprecated": true } }, "required": [ "name", "fulfiller_team_id", "measurement_unit", "length", "width", "height", "weight_unit", "weight" ], "type": "object", "additionalProperties": false }, "APIUpdatePackageLineItemInput": { "properties": { "id": { "type": "string" }, "name": { "type": ["string", "null"] }, "sku": { "type": ["string", "null"] }, "image_url": { "type": ["string", "null"] }, "product_id": { "type": ["string", "null"] }, "quantity": { "type": "number", "format": "double" }, "core_fulfillment_order_line_item_id": { "type": ["string", "null"] }, "lot_code": { "type": ["string", "null"] }, "expiration_date": { "type": ["string", "null"], "format": "date-time" }, "weight": { "type": ["number", "null"], "format": "double" }, "weight_unit": { "type": ["string", "null"], "enum": ["G", "KG", "OZ", "LB"] }, "hs_code": { "type": ["string", "null"] }, "country_of_origin": { "type": ["string", "null"] }, "customs_description": { "type": ["string", "null"] }, "customs_value": { "type": ["number", "null"], "format": "double" }, "customs_value_currency": { "type": ["string", "null"] }, "manufacturer": { "type": ["string", "null"] }, "eccn": { "type": ["string", "null"] }, "printed_commodity_identifier": { "type": ["string", "null"] }, "code": { "type": ["string", "null"] } }, "required": ["quantity"], "type": "object", "additionalProperties": false }, "APIPublicUpdatePackageInput": { "properties": { "name": { "type": "string" }, "warehouse_id": { "type": ["string", "null"] }, "merchant_team_id": { "type": ["string", "null"] }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit" }, "weight": { "type": "number", "format": "double" }, "total_customs_value": { "type": ["number", "null"], "format": "double" }, "carrier_id": { "type": ["string", "null"] }, "service_id": { "type": ["string", "null"] }, "provider_rate_id": { "type": ["string", "null"] }, "carton_id": { "type": ["string", "null"] }, "carrier_integration_id": { "type": ["string", "null"] }, "package_line_items": { "items": { "$ref": "#/components/schemas/APIUpdatePackageLineItemInput" }, "type": "array" }, "config": { "$ref": "#/components/schemas/APIPackageConfigInput", "description": "Package-level configuration" }, "from_address_name": { "type": ["string", "null"] }, "from_address_company": { "type": ["string", "null"] }, "from_address_address1": { "type": ["string", "null"] }, "from_address_address2": { "type": ["string", "null"] }, "from_address_city": { "type": ["string", "null"] }, "from_address_state": { "type": ["string", "null"] }, "from_address_zip": { "type": ["string", "null"] }, "from_address_country": { "type": ["string", "null"] }, "from_address_phone": { "type": ["string", "null"] }, "from_address_email": { "type": ["string", "null"] }, "to_address_name": { "type": ["string", "null"] }, "to_address_company": { "type": ["string", "null"] }, "to_address_address1": { "type": ["string", "null"] }, "to_address_address2": { "type": ["string", "null"] }, "to_address_city": { "type": ["string", "null"] }, "to_address_state": { "type": ["string", "null"] }, "to_address_zip": { "type": ["string", "null"] }, "to_address_country": { "type": ["string", "null"] }, "to_address_phone": { "type": ["string", "null"] }, "to_address_email": { "type": ["string", "null"] }, "package_preset_id": { "type": ["string", "null"], "deprecated": true } }, "type": "object", "additionalProperties": false }, "APIPublicMinimalPackageWithActions": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "idempotency_key": { "type": ["string", "null"], "description": "Stable package identity used to reconcile unsaved packing state" }, "created_at": { "type": "string", "format": "date-time", "description": "When the package was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was last updated" }, "name": { "type": "string", "description": "Package name" }, "manifested_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was manifested" }, "shipped_at": { "type": ["string", "null"], "format": "date-time", "description": "When the package was shipped" }, "status": { "$ref": "#/components/schemas/APIPackageStatus", "description": "Package status" }, "packing_slip_url": { "type": ["string", "null"], "description": "Packing slip URL" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit" }, "type": { "$ref": "#/components/schemas/APIPackageType", "description": "Type" }, "length": { "type": "number", "format": "double", "description": "Length" }, "width": { "type": "number", "format": "double", "description": "Width" }, "height": { "type": "number", "format": "double", "description": "Height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Weight" }, "total_customs_value": { "type": ["number", "null"], "format": "double", "description": "Total customs value" }, "config": { "description": "Package-level shipping config overrides using PackageConfigSchema", "oneOf": [ { "$ref": "#/components/schemas/APIPackageConfig" }, { "type": "null" } ] }, "rate_error_data": { "description": "Structured rate error data", "oneOf": [ { "$ref": "#/components/schemas/APILabelPurchaseError" }, { "type": "null" } ] }, "error_message": { "type": ["string", "null"], "description": "Error message" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "provider_rate_id": { "type": ["string", "null"], "description": "Exact selected provider rate, when available." }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID - when present, creates `FULFILLMENT_ORDER` package with automatic address fallbacks" }, "work_order_id": { "type": ["string", "null"], "description": "Work order ID - when present (without fulfillment_order_id), creates `WORK_ORDER` package" }, "return_id": { "type": ["string", "null"], "description": "Return ID - when present, creates `RETURN` package" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID" }, "scan_form_id": { "type": ["string", "null"], "description": "Scan form ID" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name" }, "carrier_integration_type": { "description": "Carrier integration type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carton_name": { "type": ["string", "null"], "description": "Carton name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "bulk_ship_template_package_id": { "type": ["string", "null"], "description": "Bulk ship template package ID" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse ID" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "from_address_name": { "type": ["string", "null"], "description": "From address name" }, "from_address_company": { "type": ["string", "null"], "description": "From address company" }, "from_address_address1": { "type": ["string", "null"], "description": "From address street 1" }, "from_address_address2": { "type": ["string", "null"], "description": "From address street 2" }, "from_address_city": { "type": ["string", "null"], "description": "From address city" }, "from_address_state": { "type": ["string", "null"], "description": "From address state (e.g., \"CA\" for California)" }, "from_address_country": { "type": ["string", "null"], "description": "From address country (ISO 3166-1 alpha-2 code)" }, "from_address_zip": { "type": ["string", "null"], "description": "From address ZIP" }, "from_address_phone": { "type": ["string", "null"], "description": "From address phone" }, "from_address_email": { "type": ["string", "null"], "description": "From address email" }, "to_address_name": { "type": ["string", "null"], "description": "To address name" }, "to_address_company": { "type": ["string", "null"], "description": "To address company" }, "to_address_address1": { "type": ["string", "null"], "description": "To address street 1" }, "to_address_address2": { "type": ["string", "null"], "description": "To address street 2" }, "to_address_city": { "type": ["string", "null"], "description": "To address city" }, "to_address_state": { "type": ["string", "null"], "description": "To address state (e.g., \"CA\" for California)" }, "to_address_country": { "type": ["string", "null"], "description": "To address country (ISO 3166-1 alpha-2 code)" }, "to_address_zip": { "type": ["string", "null"], "description": "To address ZIP" }, "to_address_phone": { "type": ["string", "null"], "description": "To address phone" }, "to_address_email": { "type": ["string", "null"], "description": "To address email" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the shipment should be delivered (denormalized from FulfillmentOrder)" }, "line_item_hash": { "type": "string", "description": "Hash of line items for deduplication/matching" }, "total_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of all line items" }, "unique_line_item_count": { "type": "number", "format": "double", "description": "Number of unique line items" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string for the requested carrier/service (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "shipping_label_tracking_code": { "type": ["string", "null"], "description": "Tracking code from shipping label" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Tracking URL from shipping label" }, "shipping_label_formatted_service": { "type": ["string", "null"], "description": "Formatted service display string from shipping label (what was actually bought)" }, "shipping_label_url": { "type": ["string", "null"], "description": "Label URL from shipping label" }, "shipment_status": { "description": "Shipment status from shipping label", "type": ["string", "null"], "enum": [ "LABEL_PRINTED", "LABEL_PURCHASED", "ATTEMPTED_DELIVERY", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "UNKNOWN", "DELAYED" ] }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_PackageSupportedActionType_" }, "type": "array", "description": "Supported actions for this package" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "idempotency_key", "created_at", "updated_at", "name", "manifested_at", "shipped_at", "status", "packing_slip_url", "measurement_unit", "type", "length", "width", "height", "weight_unit", "weight", "total_customs_value", "config", "rate_error_data", "error_message", "carrier_id", "service_id", "picking_session_id", "fulfillment_order_id", "work_order_id", "return_id", "carton_id", "shipping_label_id", "scan_form_id", "carrier_integration_id", "carrier_integration_name", "carrier_integration_type", "carton_name", "fulfiller_team_id", "fulfiller_team_name", "bulk_ship_id", "bulk_ship_template_package_id", "warehouse_id", "warehouse_name", "merchant_team_id", "merchant_team_name", "from_address_name", "from_address_company", "from_address_address1", "from_address_address2", "from_address_city", "from_address_state", "from_address_country", "from_address_zip", "from_address_phone", "from_address_email", "to_address_name", "to_address_company", "to_address_address1", "to_address_address2", "to_address_city", "to_address_state", "to_address_country", "to_address_zip", "to_address_phone", "to_address_email", "rate_shop_id", "rate_shop_name", "deliver_by", "line_item_hash", "total_item_quantity", "unique_line_item_count", "formatted_service", "shipping_label_tracking_code", "shipping_label_tracking_url", "shipping_label_formatted_service", "shipping_label_url", "shipment_status", "supported_actions", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIPublicGetManyPackagesResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/APIPublicMinimalPackageWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "ShippingRate": { "properties": { "carrier_id": { "type": "string", "description": "Carrier ID" }, "carrier_integration_id": { "type": "string", "description": "Carrier integration ID" }, "carrier_name": { "type": "string", "description": "Carrier human readable" }, "service_name": { "type": "string", "description": "Service human readable" }, "service_id": { "type": "string", "description": "Service ID" }, "estimated_days": { "type": ["number", "null"], "format": "double", "description": "Estimated days" }, "currency": { "type": "string", "description": "Currency" }, "amount": { "type": "number", "format": "double", "description": "Amount" }, "delivery_date_guaranteed": { "type": "boolean" }, "delivery_date": { "type": ["string", "null"] }, "provider_rate_id": { "type": "string", "description": "Pass this ID to purchase the exact quoted delivery option." } }, "required": [ "carrier_id", "carrier_integration_id", "carrier_name", "service_name", "service_id", "estimated_days", "currency", "amount", "delivery_date_guaranteed", "delivery_date" ], "type": "object", "description": "Shipping rate" }, "GetPackageRatesResponse": { "description": "Response type for getting package rates", "properties": { "rates": { "items": { "$ref": "#/components/schemas/ShippingRate" }, "type": "array" }, "errors": { "items": { "properties": { "error": { "type": "string" }, "carrier_integration_id": { "type": "string" } }, "required": ["error", "carrier_integration_id"], "type": "object" }, "type": "array" } }, "required": ["rates", "errors"], "type": "object", "additionalProperties": false }, "UploadPackageLabelResponse": { "description": "Response type for uploading a package label", "properties": { "success": { "type": "boolean" }, "shipping_label_id": { "type": "string" }, "tracking_number": { "type": "string" }, "message": { "type": "string" } }, "required": ["success", "shipping_label_id", "tracking_number", "message"], "type": "object", "additionalProperties": false }, "UploadTrackingEvent": { "description": "Tracking event data for uploaded labels", "properties": { "status": { "description": "Event status (DELIVERED, IN_TRANSIT, etc)", "type": ["string", "null"], "enum": [ "UNKNOWN", "PRE_TRANSIT", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "AVAILABLE_FOR_PICKUP", "RETURN_TO_SENDER", "FAILURE", "CANCELLED", "ERROR", "DELIVERY_EXCEPTION", "ATTEMPTED_DELIVERY" ] }, "status_category": { "type": ["string", "null"], "description": "Event status category from carrier" }, "status_description": { "type": ["string", "null"], "description": "Human-readable status description" }, "event_time": { "type": ["string", "null"], "format": "date-time", "description": "When the event occurred" }, "event_code": { "type": ["string", "null"], "description": "Carrier-specific event code" }, "location_city": { "type": ["string", "null"], "description": "City where event occurred" }, "location_state": { "type": ["string", "null"], "description": "State/province where event occurred" }, "location_zip": { "type": ["string", "null"], "description": "ZIP/postal code where event occurred" }, "location_country": { "type": ["string", "null"], "description": "Country code where event occurred" }, "raw_data": { "description": "Raw event data from carrier" } }, "type": "object", "additionalProperties": false }, "UploadPackageLabelRequest": { "description": "Request type for uploading a package label", "properties": { "lock_owner": { "type": ["string", "null"] }, "data": { "properties": { "tracking_events": { "items": { "$ref": "#/components/schemas/UploadTrackingEvent" }, "type": "array", "description": "Optional tracking events to associate with the uploaded label" }, "label_cost": { "type": "number", "format": "double" }, "service_id": { "type": "string" }, "carrier_id": { "type": "string" }, "tracking_number": { "type": "string" }, "base64_content": { "type": "string" } }, "required": ["tracking_number", "base64_content"], "type": "object" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "BuyPackageLabelRequest": { "description": "Request type for buying a package label", "properties": { "provider_rate_id": { "type": "string" }, "lock_owner": { "type": ["string", "null"] }, "carrier_integration_id": { "type": "string" }, "carrier_id": { "type": "string" }, "service_id": { "type": "string" }, "print_custom_1": { "type": "string", "description": "Optional value printed in the label's first custom-reference field for this purchase." } }, "type": "object", "additionalProperties": false }, "Pick_APIFulfillPackageInput.Exclude_keyofAPIFulfillPackageInput.package_id__": { "properties": { "locked_by": { "type": ["string", "null"] } }, "required": ["locked_by"], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_APIFulfillPackageInput.package_id_": { "$ref": "#/components/schemas/Pick_APIFulfillPackageInput.Exclude_keyofAPIFulfillPackageInput.package_id__", "description": "Construct a type with the properties of T except for those in type K." }, "APIFulfillmentHoldReason": { "type": "string", "enum": [ "AWAITING_PAYMENT", "AWAITING_RETURN_ITEMS", "HIGH_RISK_OF_FRAUD", "INCORRECT_ADDRESS", "INVENTORY_OUT_OF_STOCK", "ONLINE_STORE_POST_PURCHASE_CROSS_SELL", "OTHER", "UNKNOWN_DELIVERY_DATE" ] }, "APIBaseOrderFulfillmentHold": { "properties": { "active": { "type": "boolean", "description": "Indicates whether the hold is currently enforced" }, "order_id": { "type": "string", "description": "Order ID" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the hold was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the hold was created" }, "created_by_user_id": { "type": ["string", "null"], "description": "ID of user who created the hold" }, "reason_notes": { "type": ["string", "null"], "description": "Additional notes about the hold" }, "reason": { "$ref": "#/components/schemas/APIFulfillmentHoldReason", "description": "Reason for the hold" }, "id": { "type": "string", "description": "Unique identifier for the hold" } }, "required": [ "active", "order_id", "updated_at", "created_at", "created_by_user_id", "reason_notes", "reason", "id" ], "type": "object" }, "APIBaseCoreOrderLineItem": { "properties": { "core_draft_order_line_item_id": { "type": ["string", "null"], "description": "Core draft order line item ID" }, "order_id": { "type": "string", "description": "Order ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "image_url": { "type": ["string", "null"], "description": "Line item image URL" }, "sku": { "type": ["string", "null"], "description": "Line item SKU" }, "name": { "type": "string", "description": "Line item name" }, "unsynced_quantity": { "type": "number", "format": "double", "description": "Quantity of items added in Cybership that don't exist on remote" }, "remaining_quantity": { "type": "number", "format": "double", "description": "Remaining quantity to fulfill" }, "total_quantity": { "type": "number", "format": "double", "description": "Total quantity ordered" }, "removed_quantity": { "type": "number", "format": "double", "description": "Quantity removed from the order" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was synced" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "id": { "type": "string", "description": "Unique identifier for the line item" } }, "required": [ "core_draft_order_line_item_id", "order_id", "product_id", "image_url", "sku", "name", "unsynced_quantity", "remaining_quantity", "total_quantity", "removed_quantity", "synced_at", "updated_at", "created_at", "id" ], "type": "object" }, "APIBaseOriginalOrderLineItem": { "properties": { "core_draft_order_line_item_id": { "type": ["string", "null"], "description": "Core draft order line item ID of the original order line item" }, "original_draft_order_line_item_id": { "type": ["string", "null"], "description": "Original draft line item ID of the original order line item" }, "shop_id": { "type": "string", "description": "Shop ID of the original order line item" }, "order_id": { "type": "string", "description": "Order ID of the original order line item" }, "product_id": { "type": ["string", "null"], "description": "Product ID of the original order line item" }, "product_listing_id": { "type": ["string", "null"], "description": "Denormalized: Product listing ID for navigation links" }, "product_listing_variant_id": { "type": ["string", "null"], "description": "Product listing variant ID of the original order line item" }, "image_url": { "type": ["string", "null"], "description": "Image URL of the original order line item" }, "sku": { "type": ["string", "null"], "description": "SKU of the original order line item" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from the sales channel (e.g. Shopify line item ID)" }, "applied_discount_amount": { "type": ["number", "null"], "format": "double", "description": "Total discount amount applied to this line item in shop currency" }, "price": { "type": "number", "format": "double", "description": "The unit price per item in the shop's currency, before discounts. Sourced directly from the e-commerce platform (e.g. Shopify line_items[].price). This is NOT the line total — multiply by total_quantity to get the line total." }, "name": { "type": "string", "description": "Name of the original order line item" }, "unsynced_quantity": { "type": "number", "format": "double", "description": "Quantity of items added in Cybership that don't exist on remote" }, "remaining_quantity": { "type": "number", "format": "double", "description": "Remaining quantity of the original order line item" }, "total_quantity": { "type": "number", "format": "double", "description": "Total quantity of the original order line item" }, "removed_quantity": { "type": "number", "format": "double", "description": "Quantity of the original order line item that has been removed" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the original order line item was last synced" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date and time the original order line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time the original order line item was created" }, "id": { "type": "string", "description": "Unique identifier for the original order line item" } }, "required": [ "core_draft_order_line_item_id", "original_draft_order_line_item_id", "shop_id", "order_id", "product_id", "product_listing_id", "product_listing_variant_id", "image_url", "sku", "remote_id", "applied_discount_amount", "price", "name", "unsynced_quantity", "remaining_quantity", "total_quantity", "removed_quantity", "synced_at", "updated_at", "created_at", "id" ], "type": "object" }, "APIOrderFulfillmentStatus": { "type": "string", "enum": [ "FULFILLED", "IN_PROGRESS", "ON_HOLD", "OPEN", "PARTIALLY_FULFILLED", "PENDING_FULFILLMENT", "RESTOCKED", "SCHEDULED", "UNFULFILLED", "REQUEST_DECLINED" ] }, "APIOrderPaymentStatus": { "type": "string", "enum": [ "PENDING", "PAID", "PARTIALLY_PAID", "REFUNDED", "PARTIALLY_REFUNDED", "AUTHORIZED", "EXPIRED", "VOIDED" ] }, "APIOrderPriority": { "type": "string", "enum": ["LOW", "NORMAL", "HIGH", "CRITICAL"] }, "MetadataEntry": { "properties": { "key": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number", "format": "double" } ], "nullable": true } }, "required": ["key", "value"], "type": "object", "additionalProperties": false }, "OrderMetadata": { "properties": { "custom": { "items": { "$ref": "#/components/schemas/MetadataEntry" }, "type": "array", "description": "User-managed metadata that can be edited through Cybership APIs" }, "shopify": { "items": { "$ref": "#/components/schemas/MetadataEntry" }, "type": "array", "description": "Read-only mirror of Shopify order custom attributes managed by Shopify sync" }, "woo": { "items": { "$ref": "#/components/schemas/MetadataEntry" }, "type": "array", "description": "Read-only mirror of WooCommerce order metadata managed by WooCommerce sync" }, "bigcommerce": { "items": { "$ref": "#/components/schemas/MetadataEntry" }, "type": "array", "description": "Read-only mirror of BigCommerce order metadata managed by BigCommerce sync" } }, "type": "object", "additionalProperties": false }, "OrderStatus": { "enum": ["OPEN", "ARCHIVED", "CANCELLED"], "type": "string" }, "APIAddressResidentialType": { "type": "string", "enum": ["RESIDENTIAL", "COMMERCIAL", "UNKNOWN"] }, "APICorrectedAddress": { "properties": { "zip4": { "type": ["string", "null"] }, "zip5": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "street2": { "type": ["string", "null"] }, "street1": { "type": "string" } }, "required": ["zip4", "zip5", "state", "city", "street2", "street1"], "type": "object" }, "APIAddressVerificationError": { "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": ["message", "code"], "type": "object" }, "APIDpvMatchCode": { "enum": ["Y", "S", "D", "N", ""], "type": "string" }, "APIRecordType": { "enum": ["S", "H", "F", "P", "R", "G"], "type": "string" }, "APIAddressVerificationMetadata": { "properties": { "is_active": { "type": ["boolean", "null"] }, "is_cmra": { "type": ["boolean", "null"] }, "is_vacant": { "type": ["boolean", "null"] }, "record_type": { "type": ["string", "null"], "enum": ["S", "H", "F", "P", "R", "G"] }, "dpv_footnotes": { "type": ["string", "null"] }, "dpv_match_code": { "type": ["string", "null"], "enum": ["Y", "S", "D", "N", ""] }, "longitude": { "type": ["number", "null"], "format": "double" }, "latitude": { "type": ["number", "null"], "format": "double" } }, "type": "object" }, "APIAddressVerificationResponse": { "properties": { "metadata": { "$ref": "#/components/schemas/APIAddressVerificationMetadata" }, "errors": { "items": { "$ref": "#/components/schemas/APIAddressVerificationError" }, "type": "array" }, "corrected_address": { "oneOf": [ { "$ref": "#/components/schemas/APICorrectedAddress" }, { "type": "null" } ] }, "residential": { "$ref": "#/components/schemas/APIAddressResidentialType" }, "verified": { "type": "boolean" } }, "required": ["verified"], "type": "object" }, "APIOrderConfig": { "description": "Public API order-level config response fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "address_verification_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "APIPublicExpandedOrder": { "properties": { "id": { "type": "string", "description": "Unique identifier for the order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was last updated" }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was closed" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updated_at timestamp (used to prevent processing stale webhooks)" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this order" }, "team_id": { "type": "string", "deprecated": true }, "shop_id": { "type": "string", "description": "ID of the shop this order belongs to" }, "shop_name": { "type": "string", "description": "Name of the shop this order belongs to" }, "shop_slug": { "type": ["string", "null"], "description": "Slug of the shop this order belongs to" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Type of the shop this order belongs to" }, "fulfillment_status": { "$ref": "#/components/schemas/APIOrderFulfillmentStatus", "description": "Order fulfillment status" }, "payment_status": { "$ref": "#/components/schemas/APIOrderPaymentStatus", "description": "Order payment status" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority level" }, "order_number": { "type": "string", "description": "Order number" }, "currency": { "type": "string", "description": "Order currency" }, "note": { "type": ["string", "null"], "description": "Order note" }, "metadata": { "$ref": "#/components/schemas/OrderMetadata", "description": "Metadata" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Customer delivery deadline" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Order tags" }, "total_price": { "type": "number", "format": "double", "description": "Order total price" }, "total_tax": { "type": "number", "format": "double", "description": "Order total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Order total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Source-reported shipping total; gross before discounts and refunds for Shopify orders" }, "current_shipping": { "type": "number", "format": "double", "description": "Current customer-paid shipping; Shopify uses its current amount and other sources use total_shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Order total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip/postal code" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_latitude": { "type": ["number", "null"], "format": "double", "description": "Shipping latitude" }, "shipping_longitude": { "type": ["number", "null"], "format": "double", "description": "Shipping longitude" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address line 1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address line 2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip/postal code" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID for this order" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized for performance" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID selected for this order" }, "carrier_integration_type": { "description": "Carrier integration type selected for this order", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name selected for this order" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID selected for this order" }, "service_id": { "type": ["string", "null"], "description": "Service ID selected for this order" }, "rate_shop_name": { "type": ["string", "null"], "description": "Rate shop name selected for this order" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (derived from carrier/service/integration/strategy)" }, "status": { "$ref": "#/components/schemas/OrderStatus", "description": "Computed order status based on closed_at and cancelled_at" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "lock_address": { "type": "boolean", "description": "Address lock flag - when true, ignore address updates from sales channel" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verification_response": { "description": "The address verification response data", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_hash": { "type": ["string", "null"], "description": "SHA-256 hash of the verified address for deduplication" }, "is_fragile": { "type": "boolean", "description": "Flag indicating the order contains fragile items" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "tracking_count": { "type": "number", "format": "double", "description": "Number of fulfillments with tracking numbers (denormalized for performance)" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments (denormalized for performance)" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "config": { "description": "Tiered configuration overrides for this order", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseOrderFulfillmentHold" }, "type": "array", "description": "Order fulfillment holds" }, "core_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseCoreOrderLineItem" }, "type": "array", "description": "Core order line items" }, "original_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseOriginalOrderLineItem" }, "type": "array", "description": "Original order line items" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "created_at", "updated_at", "closed_at", "cancelled_at", "remote_id", "synced_at", "merchant_team_id", "team_id", "shop_id", "shop_name", "shop_slug", "shop_type", "fulfillment_status", "payment_status", "priority", "order_number", "currency", "note", "metadata", "shipping_method", "deliver_by", "line_item_hash", "tags", "total_price", "total_tax", "total_discount", "total_shipping", "current_shipping", "total_outstanding", "shipping_address_name", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_country", "shipping_address_zip", "shipping_address_phone", "shipping_latitude", "shipping_longitude", "billing_address_name", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_country", "billing_address_zip", "billing_address_phone", "customer_email", "customer_name", "customer_phone", "carton_id", "carton_name", "carrier_integration_id", "carrier_integration_type", "carrier_integration_name", "carrier_id", "service_id", "rate_shop_name", "formatted_service", "status", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "lock_address", "address_verified", "address_residential", "address_verification_response", "address_verified_at", "address_hash", "is_fragile", "core_line_item_count", "unique_core_line_item_count", "tracking_count", "fulfillment_count", "line_item_image_urls", "config", "order_fulfillment_holds", "core_order_line_items", "original_order_line_items", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "OrderConfigFields": { "description": "Order-level packing, address-verification, and shipping config fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "address_verification_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "APIDeliveryConfirmation": { "type": "string", "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "APIMetadataEntry": { "description": "Metadata entry for orders (key-value pair)", "properties": { "key": { "type": "string", "description": "Key for the metadata entry" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number", "format": "double" } ], "nullable": true, "description": "Value for the metadata entry (string or number)" } }, "required": ["key", "value"], "type": "object", "additionalProperties": false }, "APIOrderLineItemInput": { "description": "Order line item for create requests", "properties": { "product_id": { "type": ["string", "null"], "description": "Product ID (optional for custom products)" }, "name": { "type": "string", "description": "Line item name (required for custom products)" }, "sku": { "type": ["string", "null"], "description": "Line item SKU" }, "image_url": { "type": ["string", "null"], "description": "Line item image URL" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "price": { "type": "number", "format": "double", "description": "Price" } }, "required": ["quantity", "price"], "type": "object", "additionalProperties": false }, "APIPublicCreateOrderInput": { "properties": { "shop_id": { "type": "string", "description": "Shop ID" }, "remote_id": { "type": ["string", "null"], "description": "Optional remote ID for idempotent order creation.\nIf provided, the API will reject duplicate orders with the same remote_id for the same shop (409 Conflict).\nUse this to prevent duplicate orders during retries or timeout scenarios." }, "currency": { "type": "string", "description": "Currency" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address line 1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address line 2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "note": { "type": ["string", "null"], "description": "Note" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method selected at checkout" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID for the shipment" }, "metadata": { "items": { "$ref": "#/components/schemas/APIMetadataEntry" }, "type": "array", "description": "Write-only custom metadata entries for the order. Stored internally under metadata.custom." }, "original_order_line_items": { "items": { "$ref": "#/components/schemas/APIOrderLineItemInput" }, "type": "array", "description": "Line items" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" }, "force_warehouse_id": { "type": ["string", "null"], "description": "Force the order to be routed to a specific warehouse, bypassing automatic routing.\nThis only applies to the initial order creation and is not stored on the order.\nThe warehouse must be accessible to the merchant team (owned or via fulfillment delegation)." }, "config": { "description": "Order-level configuration.", "oneOf": [ { "$ref": "#/components/schemas/OrderConfigFields" }, { "type": "null" } ] }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "insurance": { "type": ["number", "null"], "format": "double", "deprecated": true }, "delivery_confirmation": { "deprecated": true, "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] } }, "required": [ "shop_id", "currency", "total_tax", "total_discount", "total_shipping", "total_outstanding", "original_order_line_items" ], "type": "object", "additionalProperties": false }, "APIPublicListOrder": { "properties": { "id": { "type": "string", "description": "Unique identifier for the order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created" }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was closed" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was cancelled" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "shop_name": { "type": "string", "description": "Name of the shop this order belongs to" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Type of the shop this order belongs to" }, "fulfillment_status": { "$ref": "#/components/schemas/APIOrderFulfillmentStatus", "description": "Order fulfillment status" }, "payment_status": { "$ref": "#/components/schemas/APIOrderPaymentStatus", "description": "Order payment status" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority level" }, "order_number": { "type": "string", "description": "Order number" }, "currency": { "type": "string", "description": "Order currency" }, "note": { "type": ["string", "null"], "description": "Order note" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Order tags" }, "total_price": { "type": "number", "format": "double", "description": "Order total price" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip/postal code" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments (denormalized for performance)" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "status": { "$ref": "#/components/schemas/OrderStatus", "description": "Computed order status based on closed_at and cancelled_at" } }, "required": [ "id", "created_at", "closed_at", "cancelled_at", "merchant_team_name", "shop_name", "shop_type", "fulfillment_status", "payment_status", "priority", "order_number", "currency", "note", "shipping_method", "tags", "total_price", "customer_email", "customer_name", "customer_phone", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_country", "shipping_address_zip", "address_verified", "address_residential", "core_line_item_count", "unique_core_line_item_count", "fulfillment_count", "line_item_image_urls", "status" ], "type": "object", "additionalProperties": false }, "APIPublicListOrdersResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/APIPublicListOrder" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "OrderSupportedActionType": { "enum": [ "VIEW_REMOTE_ORDER", "VIEW_ORDER", "EDIT_ORDER", "ARCHIVE_ORDER", "UNARCHIVE_ORDER", "TOGGLE_ORIGINAL_LINE_ITEMS", "HOLD_ORDER", "RELEASE_HOLD", "CANCEL_ORDER", "EDIT_SHIPPING_ADDRESS", "CREATE_RETURN", "SYNC_ORDER", "ADD_CHARGE", "DUPLICATE", "VERIFY_ADDRESS" ], "type": "string" }, "APISupportedAction_OrderSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/OrderSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIPublicExpandedOrderWithActions": { "properties": { "id": { "type": "string", "description": "Unique identifier for the order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was last updated" }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was closed" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updated_at timestamp (used to prevent processing stale webhooks)" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this order" }, "team_id": { "type": "string", "deprecated": true }, "shop_id": { "type": "string", "description": "ID of the shop this order belongs to" }, "shop_name": { "type": "string", "description": "Name of the shop this order belongs to" }, "shop_slug": { "type": ["string", "null"], "description": "Slug of the shop this order belongs to" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Type of the shop this order belongs to" }, "fulfillment_status": { "$ref": "#/components/schemas/APIOrderFulfillmentStatus", "description": "Order fulfillment status" }, "payment_status": { "$ref": "#/components/schemas/APIOrderPaymentStatus", "description": "Order payment status" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority level" }, "order_number": { "type": "string", "description": "Order number" }, "currency": { "type": "string", "description": "Order currency" }, "note": { "type": ["string", "null"], "description": "Order note" }, "metadata": { "$ref": "#/components/schemas/OrderMetadata", "description": "Metadata" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Customer delivery deadline" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Order tags" }, "total_price": { "type": "number", "format": "double", "description": "Order total price" }, "total_tax": { "type": "number", "format": "double", "description": "Order total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Order total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Source-reported shipping total; gross before discounts and refunds for Shopify orders" }, "current_shipping": { "type": "number", "format": "double", "description": "Current customer-paid shipping; Shopify uses its current amount and other sources use total_shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Order total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip/postal code" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_latitude": { "type": ["number", "null"], "format": "double", "description": "Shipping latitude" }, "shipping_longitude": { "type": ["number", "null"], "format": "double", "description": "Shipping longitude" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address line 1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address line 2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip/postal code" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID for this order" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized for performance" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID selected for this order" }, "carrier_integration_type": { "description": "Carrier integration type selected for this order", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name selected for this order" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID selected for this order" }, "service_id": { "type": ["string", "null"], "description": "Service ID selected for this order" }, "rate_shop_name": { "type": ["string", "null"], "description": "Rate shop name selected for this order" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (derived from carrier/service/integration/strategy)" }, "status": { "$ref": "#/components/schemas/OrderStatus", "description": "Computed order status based on closed_at and cancelled_at" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "lock_address": { "type": "boolean", "description": "Address lock flag - when true, ignore address updates from sales channel" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verification_response": { "description": "The address verification response data", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_hash": { "type": ["string", "null"], "description": "SHA-256 hash of the verified address for deduplication" }, "is_fragile": { "type": "boolean", "description": "Flag indicating the order contains fragile items" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "tracking_count": { "type": "number", "format": "double", "description": "Number of fulfillments with tracking numbers (denormalized for performance)" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments (denormalized for performance)" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "config": { "description": "Tiered configuration overrides for this order", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseOrderFulfillmentHold" }, "type": "array", "description": "Order fulfillment holds" }, "core_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseCoreOrderLineItem" }, "type": "array", "description": "Core order line items" }, "original_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseOriginalOrderLineItem" }, "type": "array", "description": "Original order line items" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_OrderSupportedActionType_" }, "type": "array", "description": "Supported actions for this order" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "created_at", "updated_at", "closed_at", "cancelled_at", "remote_id", "synced_at", "merchant_team_id", "team_id", "shop_id", "shop_name", "shop_slug", "shop_type", "fulfillment_status", "payment_status", "priority", "order_number", "currency", "note", "metadata", "shipping_method", "deliver_by", "line_item_hash", "tags", "total_price", "total_tax", "total_discount", "total_shipping", "current_shipping", "total_outstanding", "shipping_address_name", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_country", "shipping_address_zip", "shipping_address_phone", "shipping_latitude", "shipping_longitude", "billing_address_name", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_country", "billing_address_zip", "billing_address_phone", "customer_email", "customer_name", "customer_phone", "carton_id", "carton_name", "carrier_integration_id", "carrier_integration_type", "carrier_integration_name", "carrier_id", "service_id", "rate_shop_name", "formatted_service", "status", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "lock_address", "address_verified", "address_residential", "address_verification_response", "address_verified_at", "address_hash", "is_fragile", "core_line_item_count", "unique_core_line_item_count", "tracking_count", "fulfillment_count", "line_item_image_urls", "config", "order_fulfillment_holds", "core_order_line_items", "original_order_line_items", "supported_actions", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIPublicMinimalOrder": { "properties": { "id": { "type": "string", "description": "Unique identifier for the order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was last updated" }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was closed" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updated_at timestamp (used to prevent processing stale webhooks)" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this order" }, "team_id": { "type": "string", "deprecated": true }, "shop_id": { "type": "string", "description": "ID of the shop this order belongs to" }, "shop_name": { "type": "string", "description": "Name of the shop this order belongs to" }, "shop_slug": { "type": ["string", "null"], "description": "Slug of the shop this order belongs to" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Type of the shop this order belongs to" }, "fulfillment_status": { "$ref": "#/components/schemas/APIOrderFulfillmentStatus", "description": "Order fulfillment status" }, "payment_status": { "$ref": "#/components/schemas/APIOrderPaymentStatus", "description": "Order payment status" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority level" }, "order_number": { "type": "string", "description": "Order number" }, "currency": { "type": "string", "description": "Order currency" }, "note": { "type": ["string", "null"], "description": "Order note" }, "metadata": { "$ref": "#/components/schemas/OrderMetadata", "description": "Metadata" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Customer delivery deadline" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Order tags" }, "total_price": { "type": "number", "format": "double", "description": "Order total price" }, "total_tax": { "type": "number", "format": "double", "description": "Order total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Order total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Source-reported shipping total; gross before discounts and refunds for Shopify orders" }, "current_shipping": { "type": "number", "format": "double", "description": "Current customer-paid shipping; Shopify uses its current amount and other sources use total_shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Order total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip/postal code" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_latitude": { "type": ["number", "null"], "format": "double", "description": "Shipping latitude" }, "shipping_longitude": { "type": ["number", "null"], "format": "double", "description": "Shipping longitude" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address line 1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address line 2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip/postal code" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID for this order" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized for performance" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID selected for this order" }, "carrier_integration_type": { "description": "Carrier integration type selected for this order", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name selected for this order" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID selected for this order" }, "service_id": { "type": ["string", "null"], "description": "Service ID selected for this order" }, "rate_shop_name": { "type": ["string", "null"], "description": "Rate shop name selected for this order" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (derived from carrier/service/integration/strategy)" }, "status": { "$ref": "#/components/schemas/OrderStatus", "description": "Computed order status based on closed_at and cancelled_at" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "lock_address": { "type": "boolean", "description": "Address lock flag - when true, ignore address updates from sales channel" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verification_response": { "description": "The address verification response data", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_hash": { "type": ["string", "null"], "description": "SHA-256 hash of the verified address for deduplication" }, "is_fragile": { "type": "boolean", "description": "Flag indicating the order contains fragile items" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "tracking_count": { "type": "number", "format": "double", "description": "Number of fulfillments with tracking numbers (denormalized for performance)" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments (denormalized for performance)" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "config": { "description": "Tiered configuration overrides for this order", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseOrderFulfillmentHold" }, "type": "array", "description": "Order fulfillment holds" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "created_at", "updated_at", "closed_at", "cancelled_at", "remote_id", "synced_at", "merchant_team_id", "team_id", "shop_id", "shop_name", "shop_slug", "shop_type", "fulfillment_status", "payment_status", "priority", "order_number", "currency", "note", "metadata", "shipping_method", "deliver_by", "line_item_hash", "tags", "total_price", "total_tax", "total_discount", "total_shipping", "current_shipping", "total_outstanding", "shipping_address_name", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_country", "shipping_address_zip", "shipping_address_phone", "shipping_latitude", "shipping_longitude", "billing_address_name", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_country", "billing_address_zip", "billing_address_phone", "customer_email", "customer_name", "customer_phone", "carton_id", "carton_name", "carrier_integration_id", "carrier_integration_type", "carrier_integration_name", "carrier_id", "service_id", "rate_shop_name", "formatted_service", "status", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "lock_address", "address_verified", "address_residential", "address_verification_response", "address_verified_at", "address_hash", "is_fragile", "core_line_item_count", "unique_core_line_item_count", "tracking_count", "fulfillment_count", "line_item_image_urls", "config", "order_fulfillment_holds", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIEditOrderResponse": { "description": "Edit order response", "properties": { "success": { "type": "boolean", "description": "Whether the edit was successful" }, "order_id": { "type": "string", "description": "The edited order ID" } }, "required": ["success", "order_id"], "type": "object", "additionalProperties": false }, "APIEditOrderLineItemInput": { "description": "Edit order line item input", "properties": { "id": { "type": ["string", "null"], "description": "The core order line item ID (null for new items)" }, "product_id": { "type": ["string", "null"], "description": "Product ID - null for custom items" }, "name": { "type": "string", "description": "Item name" }, "sku": { "type": ["string", "null"], "description": "SKU" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "quantity": { "type": "number", "format": "double", "description": "The new quantity for this item (0 to remove)" }, "price": { "type": "number", "format": "double", "description": "Price per item" } }, "required": ["id", "product_id", "name", "sku", "image_url", "quantity", "price"], "type": "object", "additionalProperties": false }, "APIOrderConfigInput": { "description": "Public API order-level config input fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "address_verification_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "APIEditOrderInput": { "description": "Edit order input", "properties": { "line_items": { "items": { "$ref": "#/components/schemas/APIEditOrderLineItemInput" }, "type": "array", "description": "The updated line items" }, "edit_reason": { "type": ["string", "null"], "description": "Optional reason for the edit - will be logged in order logs if provided" }, "force_warehouse_id": { "type": ["string", "null"], "description": "Optional: Force routing to a specific warehouse after edit" }, "config": { "description": "Order-level configuration", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfigInput" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "APIPublicUpdateOrderPriorityResponse": { "properties": { "id": { "type": "string", "description": "Unique identifier for the order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was last updated" }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was closed" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updated_at timestamp (used to prevent processing stale webhooks)" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this order" }, "team_id": { "type": "string", "deprecated": true }, "shop_id": { "type": "string", "description": "ID of the shop this order belongs to" }, "shop_name": { "type": "string", "description": "Name of the shop this order belongs to" }, "shop_slug": { "type": ["string", "null"], "description": "Slug of the shop this order belongs to" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Type of the shop this order belongs to" }, "fulfillment_status": { "$ref": "#/components/schemas/APIOrderFulfillmentStatus", "description": "Order fulfillment status" }, "payment_status": { "$ref": "#/components/schemas/APIOrderPaymentStatus", "description": "Order payment status" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority level" }, "order_number": { "type": "string", "description": "Order number" }, "currency": { "type": "string", "description": "Order currency" }, "note": { "type": ["string", "null"], "description": "Order note" }, "metadata": { "$ref": "#/components/schemas/OrderMetadata", "description": "Metadata" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Customer delivery deadline" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Order tags" }, "total_price": { "type": "number", "format": "double", "description": "Order total price" }, "total_tax": { "type": "number", "format": "double", "description": "Order total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Order total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Source-reported shipping total; gross before discounts and refunds for Shopify orders" }, "current_shipping": { "type": "number", "format": "double", "description": "Current customer-paid shipping; Shopify uses its current amount and other sources use total_shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Order total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip/postal code" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_latitude": { "type": ["number", "null"], "format": "double", "description": "Shipping latitude" }, "shipping_longitude": { "type": ["number", "null"], "format": "double", "description": "Shipping longitude" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address line 1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address line 2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip/postal code" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID for this order" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized for performance" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID selected for this order" }, "carrier_integration_type": { "description": "Carrier integration type selected for this order", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name selected for this order" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID selected for this order" }, "service_id": { "type": ["string", "null"], "description": "Service ID selected for this order" }, "rate_shop_name": { "type": ["string", "null"], "description": "Rate shop name selected for this order" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (derived from carrier/service/integration/strategy)" }, "status": { "$ref": "#/components/schemas/OrderStatus", "description": "Computed order status based on closed_at and cancelled_at" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "lock_address": { "type": "boolean", "description": "Address lock flag - when true, ignore address updates from sales channel" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verification_response": { "description": "The address verification response data", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_hash": { "type": ["string", "null"], "description": "SHA-256 hash of the verified address for deduplication" }, "is_fragile": { "type": "boolean", "description": "Flag indicating the order contains fragile items" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "tracking_count": { "type": "number", "format": "double", "description": "Number of fulfillments with tracking numbers (denormalized for performance)" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments (denormalized for performance)" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "config": { "description": "Tiered configuration overrides for this order", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseOrderFulfillmentHold" }, "type": "array", "description": "Order fulfillment holds" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "id", "created_at", "updated_at", "closed_at", "cancelled_at", "remote_id", "synced_at", "merchant_team_id", "team_id", "shop_id", "shop_name", "shop_slug", "shop_type", "fulfillment_status", "payment_status", "priority", "order_number", "currency", "note", "metadata", "shipping_method", "deliver_by", "line_item_hash", "tags", "total_price", "total_tax", "total_discount", "total_shipping", "current_shipping", "total_outstanding", "shipping_address_name", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_country", "shipping_address_zip", "shipping_address_phone", "shipping_latitude", "shipping_longitude", "billing_address_name", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_country", "billing_address_zip", "billing_address_phone", "customer_email", "customer_name", "customer_phone", "carton_id", "carton_name", "carrier_integration_id", "carrier_integration_type", "carrier_integration_name", "carrier_id", "service_id", "rate_shop_name", "formatted_service", "status", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "lock_address", "address_verified", "address_residential", "address_verification_response", "address_verified_at", "address_hash", "is_fragile", "core_line_item_count", "unique_core_line_item_count", "tracking_count", "fulfillment_count", "line_item_image_urls", "config", "order_fulfillment_holds", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIUpdateOrderPriorityInput": { "description": "Update order priority input", "properties": { "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "The new priority level" } }, "required": ["priority"], "type": "object", "additionalProperties": false }, "APIPublicGetManyOrdersResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/APIPublicMinimalOrder" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "ProductStockWithActions": { "description": "Product stock with supported actions", "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized: label (null = eaches)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized: how many eaches per UoM unit (null = eaches)" }, "uom_profile_id": { "type": ["string", "null"], "description": "Live UoM profile ID (null = eaches)" }, "location_kind": { "$ref": "#/components/schemas/LocationKind", "description": "The kind of location (denormalized for dynamic view actions)" }, "location_pickable": { "type": "boolean", "description": "Whether the location is pickable (denormalized from location for performance)" }, "location_sellable": { "type": "boolean", "description": "Whether the location is sellable (denormalized from location for performance)" }, "parent_location_name": { "type": ["string", "null"], "description": "Parent location name for LPN/TOTE display" }, "location_name": { "type": "string", "description": "Location name" }, "product_type": { "$ref": "#/components/schemas/APIProductType", "description": "Denormalized: product type (for UoM selection)" }, "image_url": { "type": ["string", "null"], "description": "Product image URL" }, "sku": { "type": ["string", "null"], "description": "Product SKU" }, "name": { "type": "string", "description": "Product name" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "team_id": { "type": "string", "deprecated": true }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns the product represented by this stock" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team that owns the warehouse/location" }, "location_id": { "type": "string", "description": "Location ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID (nullable for orphaned stock after delegation deletion)" }, "created_at": { "type": "string", "format": "date-time", "description": "When the stock record was created" }, "received_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was physically received from supplier (for FIFO)" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date" }, "lot_code": { "type": ["string", "null"], "description": "Lot code" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the stock was last updated" }, "on_hand": { "type": "number", "format": "double", "description": "Quantity on hand, always in base stock units (eaches)" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ProductStockSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "location_kind", "location_pickable", "location_sellable", "parent_location_name", "location_name", "product_type", "image_url", "sku", "name", "warehouse_name", "warehouse_id", "team_id", "merchant_team_id", "fulfiller_team_id", "location_id", "product_id", "created_at", "received_at", "expiration_date", "lot_code", "updated_at", "on_hand", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "ChildLocationWithProductStockAndActions": { "description": "Child location with product stock (no nested child locations to avoid recursion)", "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" }, "product_stock": { "items": { "$ref": "#/components/schemas/ProductStockWithActions" }, "type": "array", "description": "Product stock with actions" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_LocationSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id", "product_stock", "supported_actions" ], "type": "object", "additionalProperties": false }, "ChildLocationWithProductStock": { "description": "Child location with product stock (no nested child locations to avoid recursion)", "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" }, "product_stock": { "items": { "$ref": "#/components/schemas/APIBaseProductStock" }, "type": "array", "description": "Product stock at this location" } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id", "product_stock" ], "type": "object", "additionalProperties": false }, "APIExpandedLocationWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" }, "product_stock": { "items": { "$ref": "#/components/schemas/ProductStockWithActions" }, "type": "array", "description": "Product stock with actions" }, "child_locations": { "items": { "$ref": "#/components/schemas/ChildLocationWithProductStockAndActions" }, "type": "array", "description": "Child locations" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_LocationSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id", "product_stock", "child_locations", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedLocation": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" }, "product_stock": { "items": { "$ref": "#/components/schemas/APIBaseProductStock" }, "type": "array", "description": "Product stock at this location" }, "child_locations": { "items": { "$ref": "#/components/schemas/ChildLocationWithProductStock" }, "type": "array", "description": "Child locations" } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id", "product_stock", "child_locations" ], "type": "object", "additionalProperties": false }, "APICreateLocationInput": { "description": "Input for creating a new location", "properties": { "name": { "type": "string", "description": "Name of the location" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" } }, "required": ["name", "warehouse_id"], "type": "object", "additionalProperties": false }, "APIUpdateLocationInput": { "description": "Input for updating a location - all fields are optional for partial updates\nNote: warehouse_id is immutable after creation and cannot be updated", "properties": { "name": { "type": "string", "description": "Name of the location" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" } }, "type": "object", "additionalProperties": false }, "APIMinimalLocationWithActions": { "description": "API Location with minimal data and supported actions for public API", "properties": { "barcode": { "type": "string", "description": "Barcode for scanning" }, "team_id": { "type": "string", "description": "ID of team that owns this location" }, "parent_location_name": { "type": ["string", "null"], "description": "Name of the parent location" }, "parent_location_id": { "type": ["string", "null"], "description": "ID of parent location if nested" }, "warehouse_name": { "type": "string", "description": "Name of the warehouse" }, "warehouse_id": { "type": "string", "description": "ID of the warehouse this location belongs to" }, "location_type_name": { "type": ["string", "null"], "description": "Name of the location type" }, "location_type_id": { "type": ["string", "null"], "description": "ID of the location type" }, "location_kind": { "$ref": "#/components/schemas/APILocationLocationKind", "description": "Kind of location" }, "on_hand": { "type": "number", "format": "double", "description": "Total on-hand quantity at this location and its children" }, "flagged_for_review": { "type": "boolean", "description": "Whether this location has been flagged for review due to open/in-progress issues" }, "is_empty": { "type": "boolean", "description": "Whether this location is empty (no children or stock)" }, "is_hospital": { "type": "boolean", "description": "Whether this is a hospital location for damaged goods" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location was created" }, "priority": { "type": "number", "format": "double", "description": "Priority for picking (higher = higher priority)" }, "sellable": { "type": "boolean", "description": "Whether products in this location are sellable" }, "pickable": { "type": "boolean", "description": "Whether products can be picked from this location" }, "name": { "type": "string", "description": "Name of the location" }, "id": { "type": "string", "description": "Unique identifier for the location" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_LocationSupportedActionType_" }, "type": "array", "description": "Supported actions for this location" } }, "required": [ "barcode", "team_id", "parent_location_name", "parent_location_id", "warehouse_name", "warehouse_id", "location_type_name", "location_type_id", "location_kind", "on_hand", "flagged_for_review", "is_empty", "is_hospital", "updated_at", "created_at", "priority", "sellable", "pickable", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalLocationWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalLocationWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyLocationsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalLocationWithActions_", "description": "Response type for get-many operations - excludes child_locations and product_stock for lazy loading" }, "APIMoveLocationInput": { "description": "Input for moving a location to a new parent", "properties": { "parent_location_id": { "type": ["string", "null"], "description": "ID of the new parent location (null to remove the parent)" } }, "required": ["parent_location_id"], "type": "object", "additionalProperties": false }, "APIExpandedLocationType": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "team_id": { "type": "string", "description": "ID of team that owns this location type" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the location type was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the location type was created" }, "name": { "type": "string", "description": "Name of the location type" }, "id": { "type": "string", "description": "Unique identifier for the location type" } }, "required": ["team_id", "updated_at", "created_at", "name", "id"], "type": "object", "additionalProperties": false }, "APICreateLocationTypeInput": { "description": "Input for creating a new location type", "properties": { "name": { "type": "string", "description": "Name of the location type" } }, "required": ["name"], "type": "object", "additionalProperties": false }, "APIUpdateLocationTypeInput": { "description": "Input for updating a location type - all fields are optional for partial updates", "properties": { "name": { "type": "string", "description": "Name of the location type" } }, "type": "object", "additionalProperties": false }, "PaginatedResponse_APIExpandedLocationType_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIExpandedLocationType" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "InvoiceSupportedActionType": { "enum": [ "VIEW_INVOICE", "UPDATE_INVOICE", "DELETE_INVOICE", "EXPORT_PDF", "EXPORT_CSV", "ADD_EXISTING_CHARGE", "CREATE_NEW_CHARGE", "REFRESH_TOTAL", "GENERATE_REPORT" ], "type": "string" }, "APISupportedAction_InvoiceSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/InvoiceSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIPaymentPeriod": { "type": "string", "enum": ["WEEKLY", "BIWEEKLY", "MONTHLY"] }, "APIPaymentTerms": { "type": "string", "enum": ["NET_7", "NET_10", "NET_15", "NET_30", "NET_45", "NET_60", "NET_90"] }, "APIFulfillmentDelegationConfig": { "description": "Public API fulfillment-delegation-level config response fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "notify_customer_on_fulfillment": { "type": ["boolean", "null"] }, "auto_accept_fulfillment_requests": { "type": ["boolean", "null"] }, "auto_accept_cancellation_requests": { "type": ["boolean", "null"] }, "auto_reject_unshippable_orders": { "type": ["boolean", "null"] }, "address_verification_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] }, "shipping_correction_pricing_policy": { "type": ["string", "null"], "enum": ["ORIGINAL_SHIPPING_MULTIPLIER", "PASSTHROUGH", "CUSTOM_MULTIPLIER", null] }, "shipping_correction_custom_multiplier": { "type": ["number", "null"], "format": "double" } }, "type": "object", "additionalProperties": false }, "APIBaseFulfillmentDelegation": { "properties": { "override_rate_card_name": { "type": ["string", "null"], "description": "Name of the override rate card" }, "override_rate_card_id": { "type": ["string", "null"], "description": "Override rate card ID" }, "base_rate_card_name": { "type": ["string", "null"], "description": "Name of the base rate card" }, "base_rate_card_id": { "type": ["string", "null"], "description": "Base rate card ID" }, "default_carton_id": { "type": ["string", "null"], "description": "Default carton ID" }, "config": { "description": "Tiered configuration — delegation-level overrides", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentDelegationConfig" }, { "type": "null" } ] }, "enforce_enabled_cartons": { "type": "boolean", "description": "Whether to enforce enabled cartons" }, "fulfillment_paused_at": { "type": ["string", "null"], "format": "date-time", "description": "When fulfillment was paused for this delegation. Null means fulfillment is active." }, "payment_terms": { "$ref": "#/components/schemas/APIPaymentTerms", "description": "Payment terms for this delegation" }, "payment_period": { "$ref": "#/components/schemas/APIPaymentPeriod", "description": "Payment period for this delegation" }, "currency": { "type": "string", "description": "Currency for this delegation" }, "merchant_team_name": { "type": "string", "description": "name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the fulfillment delegation was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the fulfillment delegation was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "override_rate_card_name", "override_rate_card_id", "base_rate_card_name", "base_rate_card_id", "default_carton_id", "config", "enforce_enabled_cartons", "fulfillment_paused_at", "payment_terms", "payment_period", "currency", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "updated_at", "created_at", "id" ], "type": "object" }, "APIInvoiceStatus": { "type": "string", "enum": ["PAID", "UNPAID", "PARTIALLY_PAID", "DRAFT"] }, "APIExpandedInvoiceWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "merchant_team_name": { "type": "string", "description": "Name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "What team is being billed for the invoice" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "What team is billing for the invoice" }, "fulfillment_delegation_id": { "type": "string", "description": "What fulfillment delegation this invoice is for" }, "error_message": { "type": ["string", "null"], "description": "Error message if the invoice calculation failed" }, "started_calculation_at": { "type": ["string", "null"], "format": "date-time", "description": "When the invoice charge calculation started" }, "credit_amount": { "type": "number", "format": "double", "description": "Sum of all credit charges (shown as positive for display)" }, "subscription_amount": { "type": "number", "format": "double", "description": "Pro-rated subscription amount" }, "minimum_amount": { "type": "number", "format": "double", "description": "Pro-rated minimum amount" }, "subtotal_amount": { "type": "number", "format": "double", "description": "Sum of all non-credit charges" }, "total_amount": { "type": "number", "format": "double", "description": "Total amount after adding minimum and subscription amounts and subtracting credits" }, "status": { "$ref": "#/components/schemas/APIInvoiceStatus", "description": "Status of the invoice" }, "due_date": { "type": ["string", "null"], "format": "date-time", "description": "Due date of the invoice" }, "end_date": { "type": "string", "format": "date-time", "description": "End date of the invoice period" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the invoice period" }, "currency": { "type": "string", "description": "Currency of the invoice" }, "invoice_number": { "type": "string", "description": "Human-readable invoice number (e.g., #INV-0001)" }, "name": { "type": "string", "description": "Descriptive name of the invoice" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the invoice was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the invoice was created" }, "id": { "type": "string", "description": "Unique identifier" }, "fulfillment_delegation": { "$ref": "#/components/schemas/APIBaseFulfillmentDelegation" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_InvoiceSupportedActionType_" }, "type": "array", "description": "Supported actions for this invoice" } }, "required": [ "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "fulfillment_delegation_id", "error_message", "started_calculation_at", "credit_amount", "subscription_amount", "minimum_amount", "subtotal_amount", "total_amount", "status", "due_date", "end_date", "start_date", "currency", "invoice_number", "name", "updated_at", "created_at", "id", "fulfillment_delegation", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIMinimalInvoice": { "description": "API Invoice used in webhooks and CUD operations, without supported actions\nThis is a minimal representation suitable for list views", "properties": { "merchant_team_name": { "type": "string", "description": "Name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "What team is being billed for the invoice" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "What team is billing for the invoice" }, "fulfillment_delegation_id": { "type": "string", "description": "What fulfillment delegation this invoice is for" }, "error_message": { "type": ["string", "null"], "description": "Error message if the invoice calculation failed" }, "started_calculation_at": { "type": ["string", "null"], "format": "date-time", "description": "When the invoice charge calculation started" }, "credit_amount": { "type": "number", "format": "double", "description": "Sum of all credit charges (shown as positive for display)" }, "subscription_amount": { "type": "number", "format": "double", "description": "Pro-rated subscription amount" }, "minimum_amount": { "type": "number", "format": "double", "description": "Pro-rated minimum amount" }, "subtotal_amount": { "type": "number", "format": "double", "description": "Sum of all non-credit charges" }, "total_amount": { "type": "number", "format": "double", "description": "Total amount after adding minimum and subscription amounts and subtracting credits" }, "status": { "$ref": "#/components/schemas/APIInvoiceStatus", "description": "Status of the invoice" }, "due_date": { "type": ["string", "null"], "format": "date-time", "description": "Due date of the invoice" }, "end_date": { "type": "string", "format": "date-time", "description": "End date of the invoice period" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the invoice period" }, "currency": { "type": "string", "description": "Currency of the invoice" }, "invoice_number": { "type": "string", "description": "Human-readable invoice number (e.g., #INV-0001)" }, "name": { "type": "string", "description": "Descriptive name of the invoice" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the invoice was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the invoice was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "fulfillment_delegation_id", "error_message", "started_calculation_at", "credit_amount", "subscription_amount", "minimum_amount", "subtotal_amount", "total_amount", "status", "due_date", "end_date", "start_date", "currency", "invoice_number", "name", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "APIGetManyInvoicesResponse": { "description": "Response for getting multiple invoices", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalInvoice" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIExpandedInvoice": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "merchant_team_name": { "type": "string", "description": "Name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "What team is being billed for the invoice" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "What team is billing for the invoice" }, "fulfillment_delegation_id": { "type": "string", "description": "What fulfillment delegation this invoice is for" }, "error_message": { "type": ["string", "null"], "description": "Error message if the invoice calculation failed" }, "started_calculation_at": { "type": ["string", "null"], "format": "date-time", "description": "When the invoice charge calculation started" }, "credit_amount": { "type": "number", "format": "double", "description": "Sum of all credit charges (shown as positive for display)" }, "subscription_amount": { "type": "number", "format": "double", "description": "Pro-rated subscription amount" }, "minimum_amount": { "type": "number", "format": "double", "description": "Pro-rated minimum amount" }, "subtotal_amount": { "type": "number", "format": "double", "description": "Sum of all non-credit charges" }, "total_amount": { "type": "number", "format": "double", "description": "Total amount after adding minimum and subscription amounts and subtracting credits" }, "status": { "$ref": "#/components/schemas/APIInvoiceStatus", "description": "Status of the invoice" }, "due_date": { "type": ["string", "null"], "format": "date-time", "description": "Due date of the invoice" }, "end_date": { "type": "string", "format": "date-time", "description": "End date of the invoice period" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the invoice period" }, "currency": { "type": "string", "description": "Currency of the invoice" }, "invoice_number": { "type": "string", "description": "Human-readable invoice number (e.g., #INV-0001)" }, "name": { "type": "string", "description": "Descriptive name of the invoice" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the invoice was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the invoice was created" }, "id": { "type": "string", "description": "Unique identifier" }, "fulfillment_delegation": { "$ref": "#/components/schemas/APIBaseFulfillmentDelegation" } }, "required": [ "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "fulfillment_delegation_id", "error_message", "started_calculation_at", "credit_amount", "subscription_amount", "minimum_amount", "subtotal_amount", "total_amount", "status", "due_date", "end_date", "start_date", "currency", "invoice_number", "name", "updated_at", "created_at", "id", "fulfillment_delegation" ], "type": "object", "additionalProperties": false }, "APICreateInvoiceInput": { "description": "Input for creating an invoice", "properties": { "name": { "type": "string", "description": "Descriptive name of the invoice" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the invoice period" }, "end_date": { "type": "string", "format": "date-time", "description": "End date of the invoice period" }, "due_date": { "type": ["string", "null"], "format": "date-time", "description": "Due date of the invoice" }, "status": { "$ref": "#/components/schemas/APIInvoiceStatus", "description": "Status of the invoice" }, "fulfillment_delegation_id": { "type": "string", "description": "What fulfillment delegation this invoice is for" }, "fulfiller_team_id": { "type": "string", "description": "What team is billing for the invoice" }, "merchant_team_id": { "type": "string", "description": "What team is being billed for the invoice" } }, "required": [ "name", "start_date", "end_date", "fulfillment_delegation_id", "fulfiller_team_id", "merchant_team_id" ], "type": "object", "additionalProperties": false }, "APIUpdateInvoiceInput": { "description": "Input for updating an invoice", "properties": { "name": { "type": "string", "description": "Descriptive name of the invoice" }, "start_date": { "type": "string", "format": "date-time", "description": "Start date of the invoice period" }, "end_date": { "type": "string", "format": "date-time", "description": "End date of the invoice period" }, "due_date": { "type": ["string", "null"], "format": "date-time", "description": "Due date of the invoice" }, "status": { "$ref": "#/components/schemas/APIInvoiceStatus", "description": "Status of the invoice" } }, "type": "object", "additionalProperties": false }, "FulfillmentSupportedActionType": { "enum": [ "VIEW_FULFILLMENT", "VIEW_FULFILLMENT_ORDER", "VIEW_ORDER", "TRACK_SHIPMENT", "VIEW_PDF_SHIPPING_LABEL", "VIEW_SHIPPING_LABEL", "VIEW_PICKING_SESSION", "VIEW_BULK_SHIP", "REVERT_FULFILLMENT", "RESTOCK_FULFILLMENT_ITEMS", "DEDUCT_FULFILLMENT_ITEMS" ], "type": "string" }, "APISupportedAction_FulfillmentSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/FulfillmentSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIBaseCoreFulfillmentLineItem": { "properties": { "uom_label": { "type": ["string", "null"], "description": "Denormalized from UoM profile — human-readable label (e.g. Case, Pack)" }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double", "description": "Denormalized from UoM profile — how many eaches per UoM unit" }, "uom_profile_id": { "type": ["string", "null"], "description": "UoM packaging level that was fulfilled (null = eaches / legacy)" }, "bulk_ship_template_package_line_item_id": { "type": ["string", "null"], "description": "Bulk ship template package line item ID" }, "package_line_item_id": { "type": "string", "description": "Package line item ID" }, "core_order_line_item_id": { "type": ["string", "null"], "description": "Core order line item ID" }, "core_fulfillment_order_line_item_id": { "type": ["string", "null"], "description": "Core fulfillment order line item ID" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "expiration_date": { "type": ["string", "null"], "format": "date-time", "description": "Expiration date" }, "lot_code": { "type": ["string", "null"], "description": "Lot code" }, "quantity": { "type": "number", "format": "double", "description": "Quantity fulfilled" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "sku": { "type": ["string", "null"], "description": "SKU" }, "name": { "type": "string", "description": "Line item name" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "fulfillment_id": { "type": "string", "description": "Fulfillment ID this line item belongs to" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "uom_label", "uom_multiplier_to_eaches", "uom_profile_id", "bulk_ship_template_package_line_item_id", "package_line_item_id", "core_order_line_item_id", "core_fulfillment_order_line_item_id", "updated_at", "created_at", "expiration_date", "lot_code", "quantity", "image_url", "sku", "name", "product_id", "fulfillment_id", "id" ], "type": "object" }, "APIExpandedFulfillmentWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who packed the order (null for non-pick-and-pack)" }, "packed_by_user_id": { "type": ["string", "null"], "description": "Denormalized: ID of the user who packed the order (null for non-pick-and-pack)" }, "picked_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who picked the order (null for non-pick-and-pack)" }, "picked_by_user_id": { "type": ["string", "null"], "description": "Denormalized: ID of the user who picked the order (null for non-pick-and-pack)" }, "has_packshots": { "type": "boolean", "description": "Whether the fulfillment's package has packshot photos" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview (denormalized for performance)" }, "unique_core_item_count": { "type": "number", "format": "double", "description": "Unique count of core line items by product/sku/name (denormalized for list performance)" }, "total_core_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of core line items (denormalized for list performance)" }, "carton_name": { "type": ["string", "null"], "description": "Carton name (denormalized)" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID (denormalized)" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID (denormalized)" }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID (denormalized)" }, "package_type": { "description": "Package type (denormalized)", "type": ["string", "null"], "enum": ["FULFILLMENT_ORDER", "WORK_ORDER", "STANDALONE", "RETURN"] }, "shipping_label_label_url": { "type": ["string", "null"], "description": "Shipping label label URL (denormalized)" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Shipping label tracking URL (denormalized)" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "package_id": { "type": "string", "description": "Package ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID this fulfillment belongs to" }, "shop_name": { "type": ["string", "null"], "description": "Shop name" }, "shop_id": { "type": ["string", "null"], "description": "Shop ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID for the fulfillment" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (e.g., \"USPS / Priority Mail\")" }, "tracking_code": { "type": ["string", "null"], "description": "Tracking code for the fulfillment" }, "type": { "$ref": "#/components/schemas/APIFulfillmentType", "description": "Fulfillment type" }, "shipment_status": { "$ref": "#/components/schemas/APIFulfillmentShipmentStatus", "description": "Shipment status" }, "status": { "$ref": "#/components/schemas/APIFulfillmentStatus", "description": "Fulfillment status" }, "name": { "type": ["string", "null"], "description": "Formatted name" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was synced" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the fulfillment was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the fulfillment was created" }, "id": { "type": "string", "description": "Unique identifier" }, "core_fulfillment_line_items": { "items": { "$ref": "#/components/schemas/APIBaseCoreFulfillmentLineItem" }, "type": "array", "description": "Core fulfillment line items" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_FulfillmentSupportedActionType_" }, "type": "array" } }, "required": [ "packed_by_user_name", "packed_by_user_id", "picked_by_user_name", "picked_by_user_id", "has_packshots", "line_item_image_urls", "unique_core_item_count", "total_core_item_quantity", "carton_name", "carton_id", "bulk_ship_id", "picking_session_id", "package_type", "shipping_label_label_url", "shipping_label_tracking_url", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "package_id", "fulfillment_order_id", "warehouse_name", "warehouse_id", "order_id", "shop_name", "shop_id", "shipping_label_id", "formatted_service", "tracking_code", "type", "shipment_status", "status", "name", "remote_id", "synced_at", "updated_at", "created_at", "id", "core_fulfillment_line_items", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIMinimalFulfillment": { "description": "API Fulfillment with minimal data for public API", "properties": { "packed_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who packed the order (null for non-pick-and-pack)" }, "packed_by_user_id": { "type": ["string", "null"], "description": "Denormalized: ID of the user who packed the order (null for non-pick-and-pack)" }, "picked_by_user_name": { "type": ["string", "null"], "description": "Denormalized: Name of the user who picked the order (null for non-pick-and-pack)" }, "picked_by_user_id": { "type": ["string", "null"], "description": "Denormalized: ID of the user who picked the order (null for non-pick-and-pack)" }, "has_packshots": { "type": "boolean", "description": "Whether the fulfillment's package has packshot photos" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview (denormalized for performance)" }, "unique_core_item_count": { "type": "number", "format": "double", "description": "Unique count of core line items by product/sku/name (denormalized for list performance)" }, "total_core_item_quantity": { "type": "number", "format": "double", "description": "Total quantity of core line items (denormalized for list performance)" }, "carton_name": { "type": ["string", "null"], "description": "Carton name (denormalized)" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID (denormalized)" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID (denormalized)" }, "picking_session_id": { "type": ["string", "null"], "description": "Picking session ID (denormalized)" }, "package_type": { "description": "Package type (denormalized)", "type": ["string", "null"], "enum": ["FULFILLMENT_ORDER", "WORK_ORDER", "STANDALONE", "RETURN"] }, "shipping_label_label_url": { "type": ["string", "null"], "description": "Shipping label label URL (denormalized)" }, "shipping_label_tracking_url": { "type": ["string", "null"], "description": "Shipping label tracking URL (denormalized)" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Merchant team name" }, "merchant_team_id": { "type": ["string", "null"], "description": "Merchant team ID" }, "package_id": { "type": "string", "description": "Package ID" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "warehouse_name": { "type": "string", "description": "Warehouse name" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID this fulfillment belongs to" }, "shop_name": { "type": ["string", "null"], "description": "Shop name" }, "shop_id": { "type": ["string", "null"], "description": "Shop ID" }, "shipping_label_id": { "type": ["string", "null"], "description": "Shipping label ID for the fulfillment" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (e.g., \"USPS / Priority Mail\")" }, "tracking_code": { "type": ["string", "null"], "description": "Tracking code for the fulfillment" }, "type": { "$ref": "#/components/schemas/APIFulfillmentType", "description": "Fulfillment type" }, "shipment_status": { "$ref": "#/components/schemas/APIFulfillmentShipmentStatus", "description": "Shipment status" }, "status": { "$ref": "#/components/schemas/APIFulfillmentStatus", "description": "Fulfillment status" }, "name": { "type": ["string", "null"], "description": "Formatted name" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was synced" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the fulfillment was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the fulfillment was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "packed_by_user_name", "packed_by_user_id", "picked_by_user_name", "picked_by_user_id", "has_packshots", "line_item_image_urls", "unique_core_item_count", "total_core_item_quantity", "carton_name", "carton_id", "bulk_ship_id", "picking_session_id", "package_type", "shipping_label_label_url", "shipping_label_tracking_url", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "package_id", "fulfillment_order_id", "warehouse_name", "warehouse_id", "order_id", "shop_name", "shop_id", "shipping_label_id", "formatted_service", "tracking_code", "type", "shipment_status", "status", "name", "remote_id", "synced_at", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalFulfillment_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalFulfillment" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyFulfillmentsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalFulfillment_", "description": "Response type for get-many operations (no supported_actions in list view for performance - matches orders/fulfillment-orders)" }, "APIRevertFulfillmentInput": { "properties": { "restock_items": { "type": ["array", "null"], "items": { "properties": { "expiration_date": { "type": "string", "format": "date-time", "nullable": true }, "lot_code": { "type": "string", "nullable": true }, "location_id": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "product_id": { "type": "string" } }, "required": ["expiration_date", "lot_code", "location_id", "quantity", "product_id"], "type": "object" } } }, "type": "object", "additionalProperties": false }, "FulfillmentOrderSupportedActionType": { "enum": [ "VIEW_FULFILLMENT_ORDER", "VIEW_REMOTE_ORDER", "VIEW_ORDER", "ACCEPT_CANCELLATION_REQUEST", "REJECT_CANCELLATION_REQUEST", "ACCEPT_FULFILLMENT_REQUEST", "REJECT_FULFILLMENT_REQUEST", "START_FULFILLMENT", "START_PICKING_SESSION", "REPROCESS", "CLOSE_FULFILLMENT_ORDER", "CREATE_MANUAL_FULFILLMENT", "EDIT_MANUAL_FULFILLMENT", "DELETE_MANUAL_FULFILLMENT", "VIEW_BULK_SHIP", "REMOVE_FROM_BULK_SHIP", "ENABLE_PARTIAL_FULFILLMENT", "DISABLE_PARTIAL_FULFILLMENT", "CANCEL_FULFILLMENT_REQUEST", "SUBMIT_FULFILLMENT_REQUEST", "REMOVE_FROM_PICKING_SESSION", "VIEW_PICKING_SESSION", "HOLD_FULFILLMENT", "RELEASE_HOLD", "REQUEST_CANCELLATION", "SET_DELIVER_BY", "SELECT_RATE", "SPLIT_FULFILLMENT_ORDER", "MOVE_FULFILLMENT_ORDER", "MERGE_FULFILLMENT_ORDER", "ADD_CHARGE", "CHECK_PICKING_ELIGIBILITY", "VERIFY_ADDRESS" ], "type": "string" }, "APISupportedAction_FulfillmentOrderSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/FulfillmentOrderSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIReadyToShipIssueType": { "type": "string", "enum": [ "PRODUCT_CONFIGURATION_ISSUES", "NOT_INTERNATIONAL_READY", "ADDRESS_VALIDATION_ISSUES", "ADDRESS_VERIFICATION_FAILED", "NOT_ENOUGH_STOCK" ] }, "APIBaseReadyToShipIssue": { "properties": { "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/APIReadyToShipIssueType" }, "description": { "type": "string" } }, "required": ["id", "type", "description"], "type": "object", "additionalProperties": false }, "APIBaseFulfillmentOrderFulfillmentHold": { "properties": { "remote_id": { "type": ["string", "null"], "description": "Remote ID" }, "order_fulfillment_hold_id": { "type": ["string", "null"], "description": "Order fulfillment hold ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "created_by_user_id": { "type": ["string", "null"], "description": "User who created the hold" }, "reason_notes": { "type": ["string", "null"], "description": "Additional notes about the hold" }, "reason": { "$ref": "#/components/schemas/APIFulfillmentHoldReason", "description": "Reason for the hold" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the hold was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the hold was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "remote_id", "order_fulfillment_hold_id", "fulfillment_order_id", "created_by_user_id", "reason_notes", "reason", "updated_at", "created_at", "id" ], "type": "object" }, "APIBaseCoreFulfillmentOrderLineItem": { "properties": { "core_order_line_item_id": { "type": ["string", "null"], "description": "Core order line item ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "image_url": { "type": ["string", "null"], "description": "Image URL" }, "sku": { "type": ["string", "null"], "description": "SKU" }, "allocated_quantity": { "type": "number", "format": "double", "description": "Total allocated quantity (maintained via DB trigger)" }, "deducted_quantity": { "type": "number", "format": "double", "description": "Deducted quantity" }, "remaining_quantity": { "type": "number", "format": "double", "description": "Remaining quantity" }, "total_quantity": { "type": "number", "format": "double", "description": "Total quantity" }, "name": { "type": "string", "description": "Line item name" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "core_order_line_item_id", "fulfillment_order_id", "product_id", "image_url", "sku", "allocated_quantity", "deducted_quantity", "remaining_quantity", "total_quantity", "name", "updated_at", "created_at", "id" ], "type": "object" }, "APIBaseFulfillmentOrderLock": { "description": "API lock interface for TSOA endpoints.\nRepresents the normalized lock data with proper Date objects.\nTSOA requires explicit interfaces rather than inferred types.", "properties": { "fulfillment_type": { "$ref": "#/components/schemas/APIFulfillmentType", "description": "The type of fulfillment method that is locked for this order" }, "lock_owner": { "type": "string", "description": "The owner of the lock" }, "acquired_at": { "type": "string", "format": "date-time", "description": "The date the lock was acquired" }, "expires_at": { "type": ["string", "null"], "format": "date-time", "description": "The date the lock expires" }, "display_name": { "type": "string", "description": "The name of the lock" }, "team_id": { "type": "string", "description": "The team ID" }, "user_id": { "type": "string", "description": "The user ID" }, "user_email": { "type": "string", "description": "The user email" }, "picking_session_id": { "type": "string", "description": "The picking session ID" }, "manual_fulfillment_id": { "type": "string", "description": "The manual fulfillment ID" }, "bulk_ship_id": { "type": "string", "description": "The bulk ship ID" }, "api_key_id": { "type": "string", "description": "The API key ID" } }, "required": ["fulfillment_type", "lock_owner", "acquired_at", "expires_at", "team_id"], "type": "object", "additionalProperties": false }, "APIFulfillmentOrderRequestStatus": { "type": "string", "enum": [ "UNSUBMITTED", "SUBMITTED", "ACCEPTED", "REJECTED", "CANCELLATION_REQUESTED", "CANCELLATION_ACCEPTED", "CANCELLATION_REJECTED", "CLOSED" ] }, "APIFulfillmentOrderStatus": { "type": "string", "enum": ["CLOSED", "INCOMPLETE", "CANCELLED", "IN_PROGRESS", "ON_HOLD", "OPEN", "SCHEDULED"] }, "APIFulfillmentOrderConfig": { "description": "Public API fulfillment-order-level config response fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] } }, "type": "object", "additionalProperties": false }, "APIPublicExpandedFulfillmentOrderWithActions": { "properties": { "address_verification_response": { "description": "Address verification response from carrier", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority (denormalized from order)" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "is_fragile": { "type": "boolean", "description": "Whether the order contains fragile items requiring special handling" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "order_cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "Denormalized order cancelled_at for performance" }, "order_remote_id": { "type": ["string", "null"], "description": "Denormalized order remote_id for performance" }, "order_number": { "type": "string", "description": "Order number" }, "order_config": { "description": "Denormalized order configuration used for config inheritance", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "config": { "description": "Fulfillment-order-level configuration overrides used before order/delegation/team config", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentOrderConfig" }, { "type": "null" } ] }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Denormalized shop type for performance" }, "shop_slug": { "type": ["string", "null"], "description": "Denormalized shop slug for performance" }, "shop_name": { "type": "string", "description": "Denormalized shop name for performance" }, "shop_id": { "type": "string", "description": "Shop ID" }, "shipment_mapping_id": { "type": ["string", "null"], "description": "Shipment mapping ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Denormalized carrier integration name for performance" }, "carrier_integration_type": { "description": "Denormalized carrier integration type for performance", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "fulfiller_team_name": { "type": "string", "description": "Denormalized fulfiller team name for performance" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Denormalized merchant team name for performance" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID" }, "assigned_warehouse_name": { "type": "string", "description": "Denormalized warehouse name for performance" }, "assigned_warehouse_id": { "type": "string", "description": "Warehouse ID assigned to this fulfillment order" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments created for this fulfillment order (denormalized for performance)" }, "unique_core_item_count": { "type": "number", "format": "double", "description": "Unique core item count" }, "total_core_item_quantity": { "type": "number", "format": "double", "description": "Total core item quantity" }, "shipping_address_email": { "type": ["string", "null"], "description": "Shipping address email" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "carton_name": { "type": ["string", "null"], "description": "Denormalized carton name for performance" }, "carton_id": { "type": ["string", "null"], "description": "Carton override ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "entirely_fulfillable": { "type": "boolean", "description": "Whether this order is entirely fulfillable" }, "ready_to_ship": { "type": "boolean", "description": "Whether this order is ready to ship" }, "customer_note": { "type": ["string", "null"], "description": "Customer note inherited from the parent order" }, "packer_notes": { "type": ["string", "null"], "description": "Packer notes" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "partially_fulfillable": { "type": "boolean", "description": "Whether this order is partially fulfillable" }, "is_partial": { "type": "boolean", "description": "Whether this fulfillment order is a partial fulfillment order" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "status": { "$ref": "#/components/schemas/APIFulfillmentOrderStatus", "description": "Fulfillment order status" }, "order_id": { "type": "string", "description": "Order ID this fulfillment order belongs to" }, "request_status": { "$ref": "#/components/schemas/APIFulfillmentOrderRequestStatus", "description": "Request status" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Deliver by date" }, "fulfill_by": { "type": ["string", "null"], "format": "date-time", "description": "Fulfill by date" }, "fulfill_at": { "type": "string", "format": "date-time", "description": "When to fulfill this order" }, "fulfilled_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was fulfilled" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the fulfillment order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the fulfillment order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "ready_to_ship_issues": { "items": { "$ref": "#/components/schemas/APIBaseReadyToShipIssue" }, "type": "array" }, "fulfillment_order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseFulfillmentOrderFulfillmentHold" }, "type": "array" }, "core_fulfillment_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseCoreFulfillmentOrderLineItem" }, "type": "array" }, "active_lock": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseFulfillmentOrderLock" }, { "type": "null" } ] }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_FulfillmentOrderSupportedActionType_" }, "type": "array" }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "address_verification_response", "address_verified_at", "address_residential", "address_verified", "rate_shop_name", "rate_shop_id", "priority", "formatted_service", "is_fragile", "customer_email", "customer_name", "order_cancelled_at", "order_remote_id", "order_number", "order_config", "config", "shop_type", "shop_slug", "shop_name", "shop_id", "shipment_mapping_id", "carrier_integration_name", "carrier_integration_type", "carrier_integration_id", "bulk_ship_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "assigned_warehouse_name", "assigned_warehouse_id", "line_item_image_urls", "fulfillment_count", "unique_core_item_count", "total_core_item_quantity", "shipping_address_email", "shipping_address_phone", "shipping_address_zip", "shipping_address_country", "shipping_address_state", "shipping_address_city", "shipping_address_address2", "shipping_address_address1", "shipping_address_company", "shipping_address_name", "carton_name", "carton_id", "service_id", "carrier_id", "entirely_fulfillable", "ready_to_ship", "customer_note", "packer_notes", "shipping_method", "partially_fulfillable", "is_partial", "line_item_hash", "status", "order_id", "request_status", "synced_at", "deliver_by", "fulfill_by", "fulfill_at", "fulfilled_at", "cancelled_at", "remote_id", "updated_at", "created_at", "id", "ready_to_ship_issues", "fulfillment_order_fulfillment_holds", "core_fulfillment_order_line_items", "active_lock", "supported_actions", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIPublicMinimalFulfillmentOrder": { "properties": { "address_verification_response": { "description": "Address verification response from carrier", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "rate_shop_name": { "type": ["string", "null"], "description": "Denormalized rate shop name for display" }, "rate_shop_id": { "type": ["string", "null"], "description": "Rate shop ID for dynamic rate selection" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority (denormalized from order)" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (e.g., \"USPS / Priority Mail\"), or null if no service is set" }, "is_fragile": { "type": "boolean", "description": "Whether the order contains fragile items requiring special handling" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "order_cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "Denormalized order cancelled_at for performance" }, "order_remote_id": { "type": ["string", "null"], "description": "Denormalized order remote_id for performance" }, "order_number": { "type": "string", "description": "Order number" }, "order_config": { "description": "Denormalized order configuration used for config inheritance", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "config": { "description": "Fulfillment-order-level configuration overrides used before order/delegation/team config", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentOrderConfig" }, { "type": "null" } ] }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Denormalized shop type for performance" }, "shop_slug": { "type": ["string", "null"], "description": "Denormalized shop slug for performance" }, "shop_name": { "type": "string", "description": "Denormalized shop name for performance" }, "shop_id": { "type": "string", "description": "Shop ID" }, "shipment_mapping_id": { "type": ["string", "null"], "description": "Shipment mapping ID" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Denormalized carrier integration name for performance" }, "carrier_integration_type": { "description": "Denormalized carrier integration type for performance", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID" }, "bulk_ship_id": { "type": ["string", "null"], "description": "Bulk ship ID" }, "fulfiller_team_name": { "type": "string", "description": "Denormalized fulfiller team name for performance" }, "fulfiller_team_id": { "type": "string", "description": "Fulfiller team ID" }, "merchant_team_name": { "type": ["string", "null"], "description": "Denormalized merchant team name for performance" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID" }, "assigned_warehouse_name": { "type": "string", "description": "Denormalized warehouse name for performance" }, "assigned_warehouse_id": { "type": "string", "description": "Warehouse ID assigned to this fulfillment order" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments created for this fulfillment order (denormalized for performance)" }, "unique_core_item_count": { "type": "number", "format": "double", "description": "Unique core item count" }, "total_core_item_quantity": { "type": "number", "format": "double", "description": "Total core item quantity" }, "shipping_address_email": { "type": ["string", "null"], "description": "Shipping address email" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "carton_name": { "type": ["string", "null"], "description": "Denormalized carton name for performance" }, "carton_id": { "type": ["string", "null"], "description": "Carton override ID" }, "service_id": { "type": ["string", "null"], "description": "Service ID" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID" }, "entirely_fulfillable": { "type": "boolean", "description": "Whether this order is entirely fulfillable" }, "ready_to_ship": { "type": "boolean", "description": "Whether this order is ready to ship" }, "customer_note": { "type": ["string", "null"], "description": "Customer note inherited from the parent order" }, "packer_notes": { "type": ["string", "null"], "description": "Packer notes" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "partially_fulfillable": { "type": "boolean", "description": "Whether this order is partially fulfillable" }, "is_partial": { "type": "boolean", "description": "Whether this fulfillment order is a partial fulfillment order" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "status": { "$ref": "#/components/schemas/APIFulfillmentOrderStatus", "description": "Fulfillment order status" }, "order_id": { "type": "string", "description": "Order ID this fulfillment order belongs to" }, "request_status": { "$ref": "#/components/schemas/APIFulfillmentOrderRequestStatus", "description": "Request status" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updatedAt timestamp (used to prevent processing stale webhooks)" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Deliver by date" }, "fulfill_by": { "type": ["string", "null"], "format": "date-time", "description": "Fulfill by date" }, "fulfill_at": { "type": "string", "format": "date-time", "description": "When to fulfill this order" }, "fulfilled_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was fulfilled" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When it was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the fulfillment order was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the fulfillment order was created" }, "id": { "type": "string", "description": "Unique identifier" }, "fulfillment_order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseFulfillmentOrderFulfillmentHold" }, "type": "array" }, "ready_to_ship_issues": { "items": { "$ref": "#/components/schemas/APIBaseReadyToShipIssue" }, "type": "array" }, "active_lock": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseFulfillmentOrderLock" }, { "type": "null" } ] }, "package_preset_id": { "type": ["string", "null"], "deprecated": true }, "package_preset_name": { "type": ["string", "null"], "deprecated": true } }, "required": [ "address_verification_response", "address_verified_at", "address_residential", "address_verified", "rate_shop_name", "rate_shop_id", "priority", "formatted_service", "is_fragile", "customer_email", "customer_name", "order_cancelled_at", "order_remote_id", "order_number", "order_config", "config", "shop_type", "shop_slug", "shop_name", "shop_id", "shipment_mapping_id", "carrier_integration_name", "carrier_integration_type", "carrier_integration_id", "bulk_ship_id", "fulfiller_team_name", "fulfiller_team_id", "merchant_team_name", "merchant_team_id", "assigned_warehouse_name", "assigned_warehouse_id", "line_item_image_urls", "fulfillment_count", "unique_core_item_count", "total_core_item_quantity", "shipping_address_email", "shipping_address_phone", "shipping_address_zip", "shipping_address_country", "shipping_address_state", "shipping_address_city", "shipping_address_address2", "shipping_address_address1", "shipping_address_company", "shipping_address_name", "carton_name", "carton_id", "service_id", "carrier_id", "entirely_fulfillable", "ready_to_ship", "customer_note", "packer_notes", "shipping_method", "partially_fulfillable", "is_partial", "line_item_hash", "status", "order_id", "request_status", "synced_at", "deliver_by", "fulfill_by", "fulfill_at", "fulfilled_at", "cancelled_at", "remote_id", "updated_at", "created_at", "id", "fulfillment_order_fulfillment_holds", "ready_to_ship_issues", "active_lock", "package_preset_id", "package_preset_name" ], "type": "object", "additionalProperties": false }, "APIPublicGetManyFulfillmentOrdersResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/APIPublicMinimalFulfillmentOrder" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIAcquireLockResponse": { "description": "Response type for acquiring a fulfillment order lock", "properties": { "success": { "type": "boolean" }, "lock_owner": { "type": "string" }, "expires_at": { "type": ["string", "null"], "format": "date-time" }, "extended": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "lock_owner", "expires_at", "extended", "message"], "type": "object", "additionalProperties": false }, "APIAcquireLockRequest": { "description": "Request type for acquiring a fulfillment order lock", "properties": { "lock_owner": { "type": "string" }, "timeout_minutes": { "type": "number", "format": "double" } }, "required": ["lock_owner"], "type": "object", "additionalProperties": false }, "APIReleaseLockResponse": { "description": "Response type for releasing a fulfillment order lock", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "released": { "type": "boolean" }, "lock_details": { "properties": { "fulfillment_type": { "$ref": "#/components/schemas/APIFulfillmentType" }, "original_owner": { "type": "string" }, "was_expired": { "type": "boolean" }, "id": { "type": "string" } }, "required": ["fulfillment_type", "original_owner", "was_expired", "id"], "type": "object" } }, "required": ["success", "message", "released"], "type": "object", "additionalProperties": false }, "APIReleaseLockRequest": { "description": "Request type for releasing a fulfillment order lock", "properties": { "lock_owner": { "type": "string" }, "force": { "type": "boolean" } }, "required": ["lock_owner"], "type": "object", "additionalProperties": false }, "APIAcceptCancellationResponse": { "description": "Response type for accepting a fulfillment order cancellation request", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APIAcceptCancellationRequest": { "description": "Request type for accepting a fulfillment order cancellation request", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APIRejectCancellationResponse": { "description": "Response type for rejecting a fulfillment order cancellation request", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APIRejectCancellationRequest": { "description": "Request type for rejecting a fulfillment order cancellation request", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APISubmitFulfillmentResponse": { "description": "Response type for submitting a fulfillment request", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APISubmitFulfillmentRequest": { "description": "Request type for submitting a fulfillment request", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APIAcceptFulfillmentResponse": { "description": "Response type for accepting a fulfillment request", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APIAcceptFulfillmentRequest": { "description": "Request type for accepting a fulfillment request", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APIRejectFulfillmentResponse": { "description": "Response type for rejecting a fulfillment request", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APIRejectFulfillmentRequest": { "description": "Request type for rejecting a fulfillment request", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APIStartFulfillmentResponse": { "description": "Response type for starting fulfillment", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APIStartFulfillmentRequest": { "description": "Request type for starting fulfillment", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APICloseFulfillmentOrderResponse": { "description": "Response type for closing a fulfillment order", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APICloseFulfillmentOrderRequest": { "description": "Request type for closing a fulfillment order", "properties": { "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "APISplitFulfillmentOrderResponse": { "description": "Response type for splitting a fulfillment order", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "original_fulfillment_order_id": { "type": "string" }, "new_fulfillment_order_id": { "type": "string" } }, "required": ["success", "message", "original_fulfillment_order_id", "new_fulfillment_order_id"], "type": "object", "additionalProperties": false }, "APISplitFulfillmentOrderLineItem": { "description": "Line item to split in a fulfillment order split request", "properties": { "core_fulfillment_order_line_item_id": { "type": "string" }, "quantity": { "type": "number", "format": "double" } }, "required": ["core_fulfillment_order_line_item_id", "quantity"], "type": "object", "additionalProperties": false }, "APISplitFulfillmentOrderRequest": { "description": "Request type for splitting a fulfillment order", "properties": { "line_items": { "items": { "$ref": "#/components/schemas/APISplitFulfillmentOrderLineItem" }, "type": "array" } }, "required": ["line_items"], "type": "object", "additionalProperties": false }, "APIMergeFulfillmentOrderResponse": { "description": "Response type for merging a fulfillment order", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "source_fulfillment_order_id": { "type": "string" }, "target_fulfillment_order_id": { "type": "string" }, "source_closed": { "type": "boolean" } }, "required": [ "success", "message", "source_fulfillment_order_id", "target_fulfillment_order_id", "source_closed" ], "type": "object", "additionalProperties": false }, "APIMergeFulfillmentOrderLineItem": { "description": "Line item to merge in a fulfillment order merge request", "properties": { "core_fulfillment_order_line_item_id": { "type": "string" }, "quantity": { "type": "number", "format": "double" } }, "required": ["core_fulfillment_order_line_item_id", "quantity"], "type": "object", "additionalProperties": false }, "APIMergeFulfillmentOrderRequest": { "description": "Request type for merging a fulfillment order into another", "properties": { "target_fulfillment_order_id": { "type": "string" }, "line_items": { "items": { "$ref": "#/components/schemas/APIMergeFulfillmentOrderLineItem" }, "type": "array" } }, "required": ["target_fulfillment_order_id", "line_items"], "type": "object", "additionalProperties": false }, "APIMoveFulfillmentOrderResponse": { "description": "Response type for moving a fulfillment order", "properties": { "success": { "type": "boolean" }, "fulfillment_order_id": { "type": "string" }, "new_fulfillment_order_id": { "type": "string" } }, "required": ["success", "fulfillment_order_id"], "type": "object", "additionalProperties": false }, "APIMoveFulfillmentOrderRequest": { "description": "Request type for moving a fulfillment order", "properties": { "fulfillment_order_id": { "type": "string" }, "new_warehouse_id": { "type": "string" }, "line_items": { "items": { "properties": { "quantity": { "type": "number", "format": "double" }, "core_fulfillment_order_line_item_id": { "type": "string" } }, "required": ["quantity", "core_fulfillment_order_line_item_id"], "type": "object" }, "type": "array" } }, "required": ["fulfillment_order_id", "new_warehouse_id"], "type": "object", "additionalProperties": false }, "APIUpdateCartonResponse": { "description": "Response type for updating carton on a fulfillment order", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "type": "object", "additionalProperties": false }, "APIPublicUpdateCartonRequest": { "properties": { "carton_id": { "type": ["string", "null"] }, "package_preset_id": { "type": ["string", "null"], "deprecated": true } }, "type": "object", "additionalProperties": false }, "FulfillmentDelegationSupportedActionType": { "enum": [ "VIEW_FULFILLMENT_DELEGATION", "UPDATE_FULFILLMENT_DELEGATION", "PAUSE_FULFILLMENT", "RESUME_FULFILLMENT", "DELETE_FULFILLMENT_DELEGATION" ], "type": "string" }, "APISupportedAction_FulfillmentDelegationSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/FulfillmentDelegationSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIBaseRateCard": { "properties": { "team_id": { "type": "string", "description": "ID of team that owns this rate card" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the rate card was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the rate card was created" }, "currency": { "type": "string", "description": "Currency of the rate card" }, "subscription_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for subscription amount billing" }, "subscription_amount": { "type": "number", "format": "double", "description": "Subscription amount to bill per period" }, "minimum_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Period for minimum amount billing" }, "minimum_amount": { "type": "number", "format": "double", "description": "Minimum amount to bill per period" }, "description": { "type": ["string", "null"], "description": "Description of the rate card" }, "name": { "type": "string", "description": "Name of the rate card" }, "id": { "type": "string", "description": "Unique identifier for the rate card" } }, "required": [ "team_id", "updated_at", "created_at", "currency", "subscription_period", "subscription_amount", "minimum_period", "minimum_amount", "description", "name", "id" ], "type": "object" }, "APIBaseCarton": { "properties": { "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the carton was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the carton was created" }, "team_id": { "type": "string", "description": "ID of team that owns this carton" }, "default": { "type": "boolean", "description": "Whether this is the default carton" }, "weight": { "type": "number", "format": "double", "description": "Package weight" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "height": { "type": "number", "format": "double", "description": "Package height" }, "width": { "type": "number", "format": "double", "description": "Package width" }, "length": { "type": "number", "format": "double", "description": "Package length" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit for dimensions" }, "name": { "type": "string", "description": "Carton name" }, "id": { "type": "string", "description": "Unique identifier for the carton" } }, "required": [ "updated_at", "created_at", "team_id", "default", "weight", "weight_unit", "height", "width", "length", "measurement_unit", "name", "id" ], "type": "object" }, "APIExpandedFulfillmentDelegationEnabledCarton": { "properties": { "carton_id": { "type": "string", "description": "Carton to enable" }, "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation to enable the carton for" }, "carton": { "$ref": "#/components/schemas/APIBaseCarton" } }, "required": ["carton_id", "fulfillment_delegation_id", "carton"], "type": "object", "additionalProperties": false }, "APIExpandedFulfillmentDelegationWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "override_rate_card_name": { "type": ["string", "null"], "description": "Name of the override rate card" }, "override_rate_card_id": { "type": ["string", "null"], "description": "Override rate card ID" }, "base_rate_card_name": { "type": ["string", "null"], "description": "Name of the base rate card" }, "base_rate_card_id": { "type": ["string", "null"], "description": "Base rate card ID" }, "default_carton_id": { "type": ["string", "null"], "description": "Default carton ID" }, "config": { "description": "Tiered configuration — delegation-level overrides", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentDelegationConfig" }, { "type": "null" } ] }, "enforce_enabled_cartons": { "type": "boolean", "description": "Whether to enforce enabled cartons" }, "fulfillment_paused_at": { "type": ["string", "null"], "format": "date-time", "description": "When fulfillment was paused for this delegation. Null means fulfillment is active." }, "payment_terms": { "$ref": "#/components/schemas/APIPaymentTerms", "description": "Payment terms for this delegation" }, "payment_period": { "$ref": "#/components/schemas/APIPaymentPeriod", "description": "Payment period for this delegation" }, "currency": { "type": "string", "description": "Currency for this delegation" }, "merchant_team_name": { "type": "string", "description": "name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the fulfillment delegation was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the fulfillment delegation was created" }, "id": { "type": "string", "description": "Unique identifier" }, "base_rate_card": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseRateCard" }, { "type": "null" } ] }, "override_rate_card": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseRateCard" }, { "type": "null" } ] }, "default_carton": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseCarton" }, { "type": "null" } ] }, "enabled_cartons": { "items": { "$ref": "#/components/schemas/APIExpandedFulfillmentDelegationEnabledCarton" }, "type": "array" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_FulfillmentDelegationSupportedActionType_" }, "type": "array", "description": "Supported actions for this fulfillment delegation" } }, "required": [ "override_rate_card_name", "override_rate_card_id", "base_rate_card_name", "base_rate_card_id", "default_carton_id", "config", "enforce_enabled_cartons", "fulfillment_paused_at", "payment_terms", "payment_period", "currency", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "updated_at", "created_at", "id", "base_rate_card", "override_rate_card", "default_carton", "enabled_cartons", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedFulfillmentDelegation": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "override_rate_card_name": { "type": ["string", "null"], "description": "Name of the override rate card" }, "override_rate_card_id": { "type": ["string", "null"], "description": "Override rate card ID" }, "base_rate_card_name": { "type": ["string", "null"], "description": "Name of the base rate card" }, "base_rate_card_id": { "type": ["string", "null"], "description": "Base rate card ID" }, "default_carton_id": { "type": ["string", "null"], "description": "Default carton ID" }, "config": { "description": "Tiered configuration — delegation-level overrides", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentDelegationConfig" }, { "type": "null" } ] }, "enforce_enabled_cartons": { "type": "boolean", "description": "Whether to enforce enabled cartons" }, "fulfillment_paused_at": { "type": ["string", "null"], "format": "date-time", "description": "When fulfillment was paused for this delegation. Null means fulfillment is active." }, "payment_terms": { "$ref": "#/components/schemas/APIPaymentTerms", "description": "Payment terms for this delegation" }, "payment_period": { "$ref": "#/components/schemas/APIPaymentPeriod", "description": "Payment period for this delegation" }, "currency": { "type": "string", "description": "Currency for this delegation" }, "merchant_team_name": { "type": "string", "description": "name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the fulfillment delegation was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the fulfillment delegation was created" }, "id": { "type": "string", "description": "Unique identifier" }, "base_rate_card": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseRateCard" }, { "type": "null" } ] }, "override_rate_card": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseRateCard" }, { "type": "null" } ] }, "default_carton": { "oneOf": [ { "$ref": "#/components/schemas/APIBaseCarton" }, { "type": "null" } ] }, "enabled_cartons": { "items": { "$ref": "#/components/schemas/APIExpandedFulfillmentDelegationEnabledCarton" }, "type": "array" } }, "required": [ "override_rate_card_name", "override_rate_card_id", "base_rate_card_name", "base_rate_card_id", "default_carton_id", "config", "enforce_enabled_cartons", "fulfillment_paused_at", "payment_terms", "payment_period", "currency", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "updated_at", "created_at", "id", "base_rate_card", "override_rate_card", "default_carton", "enabled_cartons" ], "type": "object", "additionalProperties": false }, "APIMeasurementSystem": { "type": "string", "enum": ["IMPERIAL", "METRIC"] }, "APIFulfillmentDelegationConfigInput": { "description": "Public API fulfillment-delegation-level config input fields.", "properties": { "require_pack_shot": { "type": ["boolean", "null"] }, "show_unfulfilled_items_on_packing_list": { "type": ["boolean", "null"] }, "show_prices_on_packing_slip": { "type": ["boolean", "null"] }, "tote_qa_enabled": { "type": ["boolean", "null"] }, "notify_customer_on_fulfillment": { "type": ["boolean", "null"] }, "auto_accept_fulfillment_requests": { "type": ["boolean", "null"] }, "auto_accept_cancellation_requests": { "type": ["boolean", "null"] }, "auto_reject_unshippable_orders": { "type": ["boolean", "null"] }, "address_verification_enabled": { "type": ["boolean", "null"] }, "incoterm": { "type": ["string", "null"], "enum": ["FAS", "FOB", "CFR", "CIF", "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP"] }, "incoterm_location": { "type": ["string", "null"] }, "eel_pfc": { "type": ["string", "null"] }, "delivery_confirmation": { "type": ["string", "null"], "enum": ["NO_SIGNATURE", "SIGNATURE", "ADULT_SIGNATURE", "INDIRECT_SIGNATURE"] }, "saturday_delivery": { "type": ["boolean", "null"], "description": "Request eligible Saturday delivery options; null inherits." }, "insurance_policy": { "oneOf": [ { "$ref": "#/components/schemas/InsurancePolicy" }, { "type": "null" } ] }, "customs_signer": { "type": ["string", "null"] }, "customs_signer_title": { "type": ["string", "null"] }, "customs_certify": { "type": ["boolean", "null"] }, "non_delivery_option": { "type": ["string", "null"], "enum": ["ABANDON", "RETURN"] }, "restriction_type": { "type": ["string", "null"], "enum": ["NONE", "OTHER", "QUARANTINE", "SANITARY_PHYTOSANITARY_INSPECTION"] }, "restriction_comments": { "type": ["string", "null"] }, "contents_type": { "type": ["string", "null"], "enum": [ "OTHER", "MERCHANDISE", "GIFT", "DOCUMENTS", "SAMPLE", "RETURNED_GOODS", "DANGEROUS_GOODS", "HUMANITARIAN_DONATION" ] }, "contents_explanation": { "type": ["string", "null"] }, "commercial_invoice_transaction_reason": { "type": ["string", "null"], "enum": ["SALE", "NON_SALE_TRANSFER", "REPAIR", "WARRANTY_REPLACEMENT", "TEMPORARY_EXPORT", "OTHER"] }, "declaration": { "type": ["string", "null"] }, "commercial_invoice_payment_terms": { "type": ["string", "null"] }, "commercial_invoice_transport_mode": { "type": ["string", "null"] }, "commercial_invoice_port_of_entry": { "type": ["string", "null"] }, "commercial_invoice_country_of_transshipment": { "type": ["string", "null"] }, "commercial_invoice_package_marks": { "type": ["string", "null"] }, "commercial_invoice_freight_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_discount_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_amount": { "type": ["number", "null"], "format": "double" }, "commercial_invoice_other_charge_description": { "type": ["string", "null"] }, "commercial_invoice_importer_tax_id": { "type": ["string", "null"] }, "commercial_invoice_importer_vat": { "type": ["string", "null"] }, "commercial_invoice_importer_eori": { "type": ["string", "null"] }, "commercial_invoice_importer_ioss": { "type": ["string", "null"] }, "commercial_invoice_vat_statement": { "type": ["string", "null"] }, "commercial_invoice_export_license_number": { "type": ["string", "null"] }, "destination_control_statement_required": { "type": ["boolean", "null"] }, "shipping_correction_pricing_policy": { "type": ["string", "null"], "enum": ["ORIGINAL_SHIPPING_MULTIPLIER", "PASSTHROUGH", "CUSTOM_MULTIPLIER", null] }, "shipping_correction_custom_multiplier": { "type": ["number", "null"], "format": "double" } }, "type": "object", "additionalProperties": false }, "APICreateFulfillmentDelegationInput": { "description": "Input for creating a fulfillment delegation", "properties": { "merchant_team": { "properties": { "default_phone_number": { "type": "string", "nullable": true, "description": "Optional default phone number" }, "image_url": { "type": "string", "nullable": true, "description": "Optional team image" }, "measurement_system": { "$ref": "#/components/schemas/APIMeasurementSystem", "description": "Measurement system for the team" }, "currency": { "type": "string", "description": "Currency for the team" }, "name": { "type": "string", "description": "Team name" } }, "required": ["measurement_system", "currency", "name"], "type": "object", "description": "Merchant team details" }, "payment_period": { "$ref": "#/components/schemas/APIPaymentPeriod", "description": "Payment period for this delegation" }, "payment_terms": { "$ref": "#/components/schemas/APIPaymentTerms", "description": "Payment terms for this delegation" }, "enforce_enabled_cartons": { "type": "boolean", "description": "Enforce enabled cartons" }, "config": { "description": "Tiered configuration — merchant-level overrides", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentDelegationConfigInput" }, { "type": "null" } ] }, "default_carton_id": { "type": ["string", "null"], "description": "Default carton ID" }, "base_rate_card_id": { "type": ["string", "null"], "description": "Base rate card ID" }, "override_rate_card_id": { "type": ["string", "null"], "description": "Override rate card ID" } }, "required": ["merchant_team", "payment_period", "payment_terms"], "type": "object", "additionalProperties": false }, "APIUpdateFulfillmentDelegationInput": { "description": "Input for updating a fulfillment delegation", "properties": { "payment_period": { "$ref": "#/components/schemas/APIPaymentPeriod", "description": "Payment period for this delegation" }, "payment_terms": { "$ref": "#/components/schemas/APIPaymentTerms", "description": "Payment terms for this delegation" }, "enforce_enabled_cartons": { "type": "boolean", "description": "Enforce enabled cartons" }, "default_carton_id": { "type": ["string", "null"], "description": "Default carton ID" }, "base_rate_card_id": { "type": ["string", "null"], "description": "Base rate card ID" }, "override_rate_card_id": { "type": ["string", "null"], "description": "Override rate card ID" }, "enabled_carton_ids": { "items": { "type": "string" }, "type": "array", "description": "Array of carton IDs that are enabled for this delegation" }, "config": { "description": "Fulfillment delegation-level configuration", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentDelegationConfigInput" }, { "type": "null" } ] } }, "type": "object", "additionalProperties": false }, "APIMinimalFulfillmentDelegationWithActions": { "description": "API FulfillmentDelegation used in get/get-many requests, with supported actions", "properties": { "override_rate_card_name": { "type": ["string", "null"], "description": "Name of the override rate card" }, "override_rate_card_id": { "type": ["string", "null"], "description": "Override rate card ID" }, "base_rate_card_name": { "type": ["string", "null"], "description": "Name of the base rate card" }, "base_rate_card_id": { "type": ["string", "null"], "description": "Base rate card ID" }, "default_carton_id": { "type": ["string", "null"], "description": "Default carton ID" }, "config": { "description": "Tiered configuration — delegation-level overrides", "oneOf": [ { "$ref": "#/components/schemas/APIFulfillmentDelegationConfig" }, { "type": "null" } ] }, "enforce_enabled_cartons": { "type": "boolean", "description": "Whether to enforce enabled cartons" }, "fulfillment_paused_at": { "type": ["string", "null"], "format": "date-time", "description": "When fulfillment was paused for this delegation. Null means fulfillment is active." }, "payment_terms": { "$ref": "#/components/schemas/APIPaymentTerms", "description": "Payment terms for this delegation" }, "payment_period": { "$ref": "#/components/schemas/APIPaymentPeriod", "description": "Payment period for this delegation" }, "currency": { "type": "string", "description": "Currency for this delegation" }, "merchant_team_name": { "type": "string", "description": "name of the merchant team" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team" }, "fulfiller_team_name": { "type": "string", "description": "Name of the fulfiller team" }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the fulfillment delegation was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the fulfillment delegation was created" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_FulfillmentDelegationSupportedActionType_" }, "type": "array", "description": "Supported actions for this fulfillment delegation" } }, "required": [ "override_rate_card_name", "override_rate_card_id", "base_rate_card_name", "base_rate_card_id", "default_carton_id", "config", "enforce_enabled_cartons", "fulfillment_paused_at", "payment_terms", "payment_period", "currency", "merchant_team_name", "merchant_team_id", "fulfiller_team_name", "fulfiller_team_id", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalFulfillmentDelegationWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalFulfillmentDelegationWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyFulfillmentDelegationsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalFulfillmentDelegationWithActions_", "description": "Response for getting multiple fulfillment delegations" }, "FileSupportedActionType": { "enum": ["VIEW_FILE", "UPDATE_FILE", "DOWNLOAD_FILE", "DELETE_FILE"], "type": "string" }, "APISupportedAction_FileSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/FileSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIFileCategory": { "type": "string", "enum": ["DOCUMENT", "IMAGE", "VIDEO", "AUDIO", "ARCHIVE", "OTHER"], "description": "Mirrors the Prisma FileCategory enum for API compatibility.\nSee: schema.prisma enum FileCategory" }, "APIFileProcessingStatus": { "type": "string", "enum": ["PENDING", "PROCESSING", "COMPLETE", "FAILED"], "description": "Mirrors the Prisma FileProcessingStatus enum for API compatibility.\nSee: schema.prisma enum FileProcessingStatus" }, "APIExpandedFileWithActions": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags for categorization" }, "team_id": { "type": "string", "description": "The team that owns the file" }, "processing_status": { "$ref": "#/components/schemas/APIFileProcessingStatus", "description": "Processing status for thumbnail generation" }, "description": { "type": ["string", "null"], "description": "Optional file description" }, "file_category": { "$ref": "#/components/schemas/APIFileCategory", "description": "Category of the file" }, "preview_blur_hash": { "type": ["string", "null"], "description": "Blur hash for loading state" }, "thumbnail_url": { "type": ["string", "null"], "description": "URL for file thumbnail" }, "size": { "type": "number", "format": "double", "description": "The size of the file in bytes" }, "mimetype": { "type": "string", "description": "The mimetype of the file (application/pdf, etc.)" }, "url": { "type": "string", "description": "The URL of the file" }, "name": { "type": "string", "description": "The name of the file" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the file was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the file was created" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_FileSupportedActionType_" }, "type": "array" } }, "required": [ "tags", "team_id", "processing_status", "description", "file_category", "preview_blur_hash", "thumbnail_url", "size", "mimetype", "url", "name", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedFile": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags for categorization" }, "team_id": { "type": "string", "description": "The team that owns the file" }, "processing_status": { "$ref": "#/components/schemas/APIFileProcessingStatus", "description": "Processing status for thumbnail generation" }, "description": { "type": ["string", "null"], "description": "Optional file description" }, "file_category": { "$ref": "#/components/schemas/APIFileCategory", "description": "Category of the file" }, "preview_blur_hash": { "type": ["string", "null"], "description": "Blur hash for loading state" }, "thumbnail_url": { "type": ["string", "null"], "description": "URL for file thumbnail" }, "size": { "type": "number", "format": "double", "description": "The size of the file in bytes" }, "mimetype": { "type": "string", "description": "The mimetype of the file (application/pdf, etc.)" }, "url": { "type": "string", "description": "The URL of the file" }, "name": { "type": "string", "description": "The name of the file" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the file was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the file was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "tags", "team_id", "processing_status", "description", "file_category", "preview_blur_hash", "thumbnail_url", "size", "mimetype", "url", "name", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "APICreateFileInput": { "description": "Input for creating a file", "properties": { "name": { "type": "string", "description": "The name of the file" }, "base64": { "type": "string", "description": "The base64 encoded file data" } }, "required": ["name", "base64"], "type": "object", "additionalProperties": false }, "APIUpdateFileInput": { "description": "Input for updating a file", "properties": { "name": { "type": "string", "description": "The name of the file" }, "url": { "type": "string", "description": "The URL of the file" }, "mimetype": { "type": "string", "description": "The mimetype of the file (application/pdf, etc.)" }, "size": { "type": "number", "format": "double", "description": "The size of the file in bytes" }, "thumbnail_url": { "type": ["string", "null"], "description": "URL for file thumbnail" }, "file_category": { "$ref": "#/components/schemas/APIFileCategory", "description": "Category of the file" }, "description": { "type": ["string", "null"], "description": "Optional file description" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags for categorization" }, "processing_status": { "$ref": "#/components/schemas/APIFileProcessingStatus", "description": "Processing status for thumbnail generation" } }, "type": "object", "additionalProperties": false }, "APIMinimalFileWithActions": { "description": "API File used in get/get-many requests, with supported actions", "properties": { "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags for categorization" }, "team_id": { "type": "string", "description": "The team that owns the file" }, "processing_status": { "$ref": "#/components/schemas/APIFileProcessingStatus", "description": "Processing status for thumbnail generation" }, "description": { "type": ["string", "null"], "description": "Optional file description" }, "file_category": { "$ref": "#/components/schemas/APIFileCategory", "description": "Category of the file" }, "preview_blur_hash": { "type": ["string", "null"], "description": "Blur hash for loading state" }, "thumbnail_url": { "type": ["string", "null"], "description": "URL for file thumbnail" }, "size": { "type": "number", "format": "double", "description": "The size of the file in bytes" }, "mimetype": { "type": "string", "description": "The mimetype of the file (application/pdf, etc.)" }, "url": { "type": "string", "description": "The URL of the file" }, "name": { "type": "string", "description": "The name of the file" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "Date when the file was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the file was created" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_FileSupportedActionType_" }, "type": "array", "description": "Supported actions for this file" } }, "required": [ "tags", "team_id", "processing_status", "description", "file_category", "preview_blur_hash", "thumbnail_url", "size", "mimetype", "url", "name", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalFileWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalFileWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyFilesResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalFileWithActions_", "description": "Response type for get-many operations" }, "APIBaseCoreDraftOrderLineItemReservation": { "properties": { "created_at": { "type": "string", "format": "date-time", "description": "When the reservation was created" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When the reservation expires (denormalized from DraftOrder.reserved_inventory_until for efficient expiration queries)" }, "quantity": { "type": "number", "format": "double", "description": "Reserved quantity" }, "warehouse_name": { "type": "string", "description": "Warehouse name (denormalized from Warehouse.name for performance)" }, "warehouse_id": { "type": "string", "description": "Warehouse ID where inventory is reserved" }, "id": { "type": "string", "description": "Unique identifier for the reservation" } }, "required": ["created_at", "reserved_inventory_until", "quantity", "warehouse_name", "warehouse_id", "id"], "type": "object" }, "APICoreDraftOrderLineItemWithReservations": { "properties": { "draft_order_id": { "type": "string", "description": "Draft order ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "image_url": { "type": ["string", "null"], "description": "Line item image URL" }, "sku": { "type": ["string", "null"], "description": "Line item SKU" }, "name": { "type": "string", "description": "Line item name" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "id": { "type": "string", "description": "Unique identifier for the line item" }, "core_draft_order_line_item_reservations": { "items": { "$ref": "#/components/schemas/APIBaseCoreDraftOrderLineItemReservation" }, "type": "array" } }, "required": [ "draft_order_id", "product_id", "quantity", "image_url", "sku", "name", "updated_at", "created_at", "id", "core_draft_order_line_item_reservations" ], "type": "object", "additionalProperties": false }, "APIBaseOriginalDraftLineItem": { "properties": { "draft_order_id": { "type": "string", "description": "Draft order ID" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "gift_card": { "type": "boolean", "description": "Whether item is a gift card" }, "requires_shipping": { "type": "boolean", "description": "Whether item requires shipping" }, "taxable": { "type": "boolean", "description": "Whether item is taxable" }, "image_url": { "type": ["string", "null"], "description": "Line item image URL" }, "name": { "type": "string", "description": "Line item name" }, "sku": { "type": ["string", "null"], "description": "Line item SKU" }, "applied_discount_amount": { "type": ["number", "null"], "format": "double", "description": "Applied discount amount" }, "price": { "type": "number", "format": "double", "description": "Price per item" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the line item was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the line item was created" }, "id": { "type": "string", "description": "Unique identifier for the line item" } }, "required": [ "draft_order_id", "product_id", "gift_card", "requires_shipping", "taxable", "image_url", "name", "sku", "applied_discount_amount", "price", "quantity", "updated_at", "created_at", "id" ], "type": "object" }, "APIDraftOrderStatus": { "type": "string", "enum": ["OPEN", "INVOICE_SENT", "COMPLETED"] }, "APIPaymentTermsType": { "type": "string", "enum": ["FIXED", "FULFILLMENT", "NET", "RECEIPT", "UNKNOWN"] }, "APIExpandedDraftOrder": { "description": "API DraftOrder used in webhooks and CUD operations, without supported actions\nThis is a minimal representation suitable for list views", "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "When the draft order was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the draft order was last updated" }, "status": { "$ref": "#/components/schemas/APIDraftOrderStatus", "description": "Status of the draft order" }, "draft_number": { "type": "string", "description": "Draft order number" }, "line_item_hash": { "type": "string", "description": "Line item hash for change detection" }, "currency": { "type": "string", "description": "Currency code" }, "total_price": { "type": "number", "format": "double", "description": "Total price" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "presentment_currency_code": { "type": ["string", "null"], "description": "Presentment currency code" }, "subtotal_price": { "type": "number", "format": "double", "description": "Subtotal price" }, "invoice_email_template_subject": { "type": ["string", "null"], "description": "Invoice email template subject" }, "market_name": { "type": ["string", "null"], "description": "Market name" }, "market_region_country_code": { "type": ["string", "null"], "description": "Market region country code" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address address1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address address2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address address1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address address2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "notes": { "type": ["string", "null"], "description": "Notes" }, "config": { "description": "Order-level configuration overrides that carry forward when converted", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "po_number": { "type": ["string", "null"], "description": "Purchase order number for B2B" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID (external system)" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the draft order was last synced" }, "invoice_url": { "type": ["string", "null"], "description": "Invoice URL" }, "invoice_sent_at": { "type": ["string", "null"], "format": "date-time", "description": "When invoice was sent" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When draft order was completed" }, "ready": { "type": "boolean", "description": "Ready for conversion (async operations complete)" }, "visible_to_customer": { "type": "boolean", "description": "Visible to customer" }, "customer_email": { "type": ["string", "null"], "description": "Customer email (consistent with Order schema)" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone (consistent with Order schema)" }, "customer_name": { "type": ["string", "null"], "description": "Customer name (consistent with Order schema)" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the order should be delivered to the customer" }, "tax_exempt": { "type": "boolean", "description": "Customer tax exempt" }, "taxes_included": { "type": "boolean", "description": "Taxes included in prices" }, "accept_automatic_discounts": { "type": "boolean", "description": "Accept automatic discounts" }, "allow_discount_codes_in_checkout": { "type": "boolean", "description": "Allow discount codes in checkout" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When reservations expire" }, "payment_terms_type": { "description": "Payment terms type", "type": ["string", "null"], "enum": ["FIXED", "FULFILLMENT", "NET", "RECEIPT", "UNKNOWN"] }, "payment_terms_name": { "type": ["string", "null"], "description": "Payment terms name" }, "payment_terms_due_in_days": { "type": ["number", "null"], "format": "double", "description": "Payment terms due in days" }, "shop_id": { "type": "string", "description": "Shop ID" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this draft order" }, "team_id": { "type": "string", "deprecated": true }, "order_id": { "type": ["string", "null"], "description": "Linked order ID" }, "shop_name": { "type": "string", "description": "Shop name (denormalized)" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type (denormalized)" }, "shop_slug": { "type": ["string", "null"], "description": "Shop slug (denormalized)" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this draft order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "core_draft_order_line_items": { "items": { "$ref": "#/components/schemas/APICoreDraftOrderLineItemWithReservations" }, "type": "array", "description": "Core draft order line items (using denormalized fields)" }, "original_draft_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseOriginalDraftLineItem" }, "type": "array", "description": "Original draft line items for creation/editing (supports virtual bundles)" } }, "required": [ "id", "created_at", "updated_at", "status", "draft_number", "line_item_hash", "currency", "total_price", "total_tax", "total_discount", "total_shipping", "total_outstanding", "presentment_currency_code", "subtotal_price", "invoice_email_template_subject", "market_name", "market_region_country_code", "shipping_address_name", "shipping_address_phone", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_zip", "shipping_address_country", "billing_address_name", "billing_address_phone", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_zip", "billing_address_country", "notes", "config", "po_number", "remote_id", "synced_at", "invoice_url", "invoice_sent_at", "completed_at", "ready", "visible_to_customer", "customer_email", "customer_phone", "customer_name", "deliver_by", "tax_exempt", "taxes_included", "accept_automatic_discounts", "allow_discount_codes_in_checkout", "reserved_inventory_until", "payment_terms_type", "payment_terms_name", "payment_terms_due_in_days", "shop_id", "merchant_team_id", "team_id", "order_id", "shop_name", "shop_type", "shop_slug", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "tags", "core_line_item_count", "unique_core_line_item_count", "core_draft_order_line_items", "original_draft_order_line_items" ], "type": "object", "additionalProperties": false }, "APIDraftOrderLineItemInput": { "description": "Draft order line item for create/update requests", "properties": { "id": { "type": ["string", "null"], "description": "Line item ID (for updates) - null means create new" }, "product_id": { "type": ["string", "null"], "description": "Product ID" }, "name": { "type": "string", "description": "Line item name (for custom products)" }, "sku": { "type": "string", "description": "Line item SKU" }, "image_url": { "type": "string", "description": "Line item image URL" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "price": { "type": "number", "format": "double", "description": "Price" } }, "required": ["quantity", "price"], "type": "object", "additionalProperties": false }, "APICreateDraftOrderInput": { "description": "Create draft order input", "properties": { "shop_id": { "type": "string", "description": "Shop ID" }, "currency": { "type": "string", "description": "Currency" }, "total_price": { "type": "number", "format": "double", "description": "Total price" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country" }, "notes": { "type": ["string", "null"], "description": "Notes" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When reservations expire" }, "original_draft_order_line_items": { "items": { "$ref": "#/components/schemas/APIDraftOrderLineItemInput" }, "type": "array", "description": "Line items" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" } }, "required": ["shop_id", "currency", "original_draft_order_line_items"], "type": "object", "additionalProperties": false }, "DraftOrderSupportedActionType": { "enum": [ "VIEW_DRAFT_ORDER", "VIEW_REMOTE_DRAFT_ORDER", "EDIT_DRAFT_ORDER", "UPDATE_DRAFT_ORDER", "CREATE_DRAFT_ORDER", "CONVERT_DRAFT_ORDER", "DELETE_DRAFT_ORDER", "VIEW_LINKED_ORDER" ], "type": "string" }, "APISupportedAction_DraftOrderSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/DraftOrderSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIExpandedDraftOrderWithActions": { "description": "API Draft Order used in get/get-many requests, with supported actions", "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "When the draft order was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the draft order was last updated" }, "status": { "$ref": "#/components/schemas/APIDraftOrderStatus", "description": "Status of the draft order" }, "draft_number": { "type": "string", "description": "Draft order number" }, "line_item_hash": { "type": "string", "description": "Line item hash for change detection" }, "currency": { "type": "string", "description": "Currency code" }, "total_price": { "type": "number", "format": "double", "description": "Total price" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "presentment_currency_code": { "type": ["string", "null"], "description": "Presentment currency code" }, "subtotal_price": { "type": "number", "format": "double", "description": "Subtotal price" }, "invoice_email_template_subject": { "type": ["string", "null"], "description": "Invoice email template subject" }, "market_name": { "type": ["string", "null"], "description": "Market name" }, "market_region_country_code": { "type": ["string", "null"], "description": "Market region country code" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address address1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address address2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address address1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address address2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "notes": { "type": ["string", "null"], "description": "Notes" }, "config": { "description": "Order-level configuration overrides that carry forward when converted", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "po_number": { "type": ["string", "null"], "description": "Purchase order number for B2B" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID (external system)" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the draft order was last synced" }, "invoice_url": { "type": ["string", "null"], "description": "Invoice URL" }, "invoice_sent_at": { "type": ["string", "null"], "format": "date-time", "description": "When invoice was sent" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When draft order was completed" }, "ready": { "type": "boolean", "description": "Ready for conversion (async operations complete)" }, "visible_to_customer": { "type": "boolean", "description": "Visible to customer" }, "customer_email": { "type": ["string", "null"], "description": "Customer email (consistent with Order schema)" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone (consistent with Order schema)" }, "customer_name": { "type": ["string", "null"], "description": "Customer name (consistent with Order schema)" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the order should be delivered to the customer" }, "tax_exempt": { "type": "boolean", "description": "Customer tax exempt" }, "taxes_included": { "type": "boolean", "description": "Taxes included in prices" }, "accept_automatic_discounts": { "type": "boolean", "description": "Accept automatic discounts" }, "allow_discount_codes_in_checkout": { "type": "boolean", "description": "Allow discount codes in checkout" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When reservations expire" }, "payment_terms_type": { "description": "Payment terms type", "type": ["string", "null"], "enum": ["FIXED", "FULFILLMENT", "NET", "RECEIPT", "UNKNOWN"] }, "payment_terms_name": { "type": ["string", "null"], "description": "Payment terms name" }, "payment_terms_due_in_days": { "type": ["number", "null"], "format": "double", "description": "Payment terms due in days" }, "shop_id": { "type": "string", "description": "Shop ID" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this draft order" }, "team_id": { "type": "string", "deprecated": true }, "order_id": { "type": ["string", "null"], "description": "Linked order ID" }, "shop_name": { "type": "string", "description": "Shop name (denormalized)" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type (denormalized)" }, "shop_slug": { "type": ["string", "null"], "description": "Shop slug (denormalized)" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this draft order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "core_draft_order_line_items": { "items": { "$ref": "#/components/schemas/APICoreDraftOrderLineItemWithReservations" }, "type": "array", "description": "Core draft order line items (using denormalized fields)" }, "original_draft_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseOriginalDraftLineItem" }, "type": "array", "description": "Original draft line items for creation/editing (supports virtual bundles)" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_DraftOrderSupportedActionType_" }, "type": "array", "description": "Supported actions for this draft order" } }, "required": [ "id", "created_at", "updated_at", "status", "draft_number", "line_item_hash", "currency", "total_price", "total_tax", "total_discount", "total_shipping", "total_outstanding", "presentment_currency_code", "subtotal_price", "invoice_email_template_subject", "market_name", "market_region_country_code", "shipping_address_name", "shipping_address_phone", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_zip", "shipping_address_country", "billing_address_name", "billing_address_phone", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_zip", "billing_address_country", "notes", "config", "po_number", "remote_id", "synced_at", "invoice_url", "invoice_sent_at", "completed_at", "ready", "visible_to_customer", "customer_email", "customer_phone", "customer_name", "deliver_by", "tax_exempt", "taxes_included", "accept_automatic_discounts", "allow_discount_codes_in_checkout", "reserved_inventory_until", "payment_terms_type", "payment_terms_name", "payment_terms_due_in_days", "shop_id", "merchant_team_id", "team_id", "order_id", "shop_name", "shop_type", "shop_slug", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "tags", "core_line_item_count", "unique_core_line_item_count", "core_draft_order_line_items", "original_draft_order_line_items", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIUpdateDraftOrderInput": { "description": "Update draft order input (all fields optional except line items)", "properties": { "currency": { "type": "string", "description": "Currency" }, "total_price": { "type": "number", "format": "double", "description": "Total price" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country" }, "notes": { "type": ["string", "null"], "description": "Notes" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When reservations expire" }, "original_draft_order_line_items": { "items": { "$ref": "#/components/schemas/APIDraftOrderLineItemInput" }, "type": "array", "description": "Line items" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" } }, "type": "object", "additionalProperties": false }, "APIExpandedOrderWithActions": { "description": "API Order used in get/get-many requests, with supported actions", "properties": { "id": { "type": "string", "description": "Unique identifier for the order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was last updated" }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was closed" }, "cancelled_at": { "type": ["string", "null"], "format": "date-time", "description": "When the order was cancelled" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID from external system" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "The remote platform's updated_at timestamp (used to prevent processing stale webhooks)" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this order" }, "team_id": { "type": "string", "deprecated": true }, "shop_id": { "type": "string", "description": "ID of the shop this order belongs to" }, "shop_name": { "type": "string", "description": "Name of the shop this order belongs to" }, "shop_slug": { "type": ["string", "null"], "description": "Slug of the shop this order belongs to" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Type of the shop this order belongs to" }, "fulfillment_status": { "$ref": "#/components/schemas/APIOrderFulfillmentStatus", "description": "Order fulfillment status" }, "payment_status": { "$ref": "#/components/schemas/APIOrderPaymentStatus", "description": "Order payment status" }, "priority": { "$ref": "#/components/schemas/APIOrderPriority", "description": "Order priority level" }, "order_number": { "type": "string", "description": "Order number" }, "currency": { "type": "string", "description": "Order currency" }, "note": { "type": ["string", "null"], "description": "Order note" }, "metadata": { "$ref": "#/components/schemas/OrderMetadata", "description": "Metadata" }, "shipping_method": { "type": ["string", "null"], "description": "Shipping method" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Customer delivery deadline" }, "line_item_hash": { "type": "string", "description": "Line item hash" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Order tags" }, "total_price": { "type": "number", "format": "double", "description": "Order total price" }, "total_tax": { "type": "number", "format": "double", "description": "Order total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Order total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Source-reported shipping total; gross before discounts and refunds for Shopify orders" }, "current_shipping": { "type": "number", "format": "double", "description": "Current customer-paid shipping; Shopify uses its current amount and other sources use total_shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Order total outstanding" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address line 1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address line 2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip/postal code" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_latitude": { "type": ["number", "null"], "format": "double", "description": "Shipping latitude" }, "shipping_longitude": { "type": ["number", "null"], "format": "double", "description": "Shipping longitude" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address line 1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address line 2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip/postal code" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "customer_email": { "type": ["string", "null"], "description": "Customer email" }, "customer_name": { "type": ["string", "null"], "description": "Customer name" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone" }, "carton_id": { "type": ["string", "null"], "description": "Carton ID for this order" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized for performance" }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID selected for this order" }, "carrier_integration_type": { "description": "Carrier integration type selected for this order", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name selected for this order" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID selected for this order" }, "service_id": { "type": ["string", "null"], "description": "Service ID selected for this order" }, "rate_shop_name": { "type": ["string", "null"], "description": "Rate shop name selected for this order" }, "formatted_service": { "type": ["string", "null"], "description": "Formatted service display string (derived from carrier/service/integration/strategy)" }, "status": { "$ref": "#/components/schemas/OrderStatus", "description": "Computed order status based on closed_at and cancelled_at" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "lock_address": { "type": "boolean", "description": "Address lock flag - when true, ignore address updates from sales channel" }, "address_verified": { "type": ["boolean", "null"], "description": "Whether the shipping address passed carrier verification (null = not checked)" }, "address_residential": { "$ref": "#/components/schemas/APIAddressResidentialType", "description": "Whether the address is residential, commercial, or unknown" }, "address_verification_response": { "description": "The address verification response data", "oneOf": [ { "$ref": "#/components/schemas/APIAddressVerificationResponse" }, { "type": "null" } ] }, "address_verified_at": { "type": ["string", "null"], "format": "date-time", "description": "When the address was last verified" }, "address_hash": { "type": ["string", "null"], "description": "SHA-256 hash of the verified address for deduplication" }, "is_fragile": { "type": "boolean", "description": "Flag indicating the order contains fragile items" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "tracking_count": { "type": "number", "format": "double", "description": "Number of fulfillments with tracking numbers (denormalized for performance)" }, "fulfillment_count": { "type": "number", "format": "double", "description": "Total number of fulfillments (denormalized for performance)" }, "line_item_image_urls": { "items": { "type": "string" }, "type": "array", "description": "Array of up to 3 line item image URLs for thumbnail preview" }, "config": { "description": "Tiered configuration overrides for this order", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "order_fulfillment_holds": { "items": { "$ref": "#/components/schemas/APIBaseOrderFulfillmentHold" }, "type": "array", "description": "Order fulfillment holds" }, "core_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseCoreOrderLineItem" }, "type": "array", "description": "Core order line items" }, "original_order_line_items": { "items": { "$ref": "#/components/schemas/APIBaseOriginalOrderLineItem" }, "type": "array", "description": "Original order line items" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_OrderSupportedActionType_" }, "type": "array", "description": "Supported actions for this order" } }, "required": [ "id", "created_at", "updated_at", "closed_at", "cancelled_at", "remote_id", "synced_at", "merchant_team_id", "team_id", "shop_id", "shop_name", "shop_slug", "shop_type", "fulfillment_status", "payment_status", "priority", "order_number", "currency", "note", "metadata", "shipping_method", "deliver_by", "line_item_hash", "tags", "total_price", "total_tax", "total_discount", "total_shipping", "current_shipping", "total_outstanding", "shipping_address_name", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_country", "shipping_address_zip", "shipping_address_phone", "shipping_latitude", "shipping_longitude", "billing_address_name", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_country", "billing_address_zip", "billing_address_phone", "customer_email", "customer_name", "customer_phone", "carton_id", "carton_name", "carrier_integration_id", "carrier_integration_type", "carrier_integration_name", "carrier_id", "service_id", "rate_shop_name", "formatted_service", "status", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "lock_address", "address_verified", "address_residential", "address_verification_response", "address_verified_at", "address_hash", "is_fragile", "core_line_item_count", "unique_core_line_item_count", "tracking_count", "fulfillment_count", "line_item_image_urls", "config", "order_fulfillment_holds", "core_order_line_items", "original_order_line_items", "supported_actions" ], "type": "object", "additionalProperties": false }, "ConvertDraftOrderResponse": { "properties": { "order": { "$ref": "#/components/schemas/APIExpandedOrderWithActions", "description": "The created order" } }, "required": ["order"], "type": "object", "additionalProperties": false }, "APIBaseDraftOrder": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "When the draft order was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the draft order was last updated" }, "status": { "$ref": "#/components/schemas/APIDraftOrderStatus", "description": "Status of the draft order" }, "draft_number": { "type": "string", "description": "Draft order number" }, "line_item_hash": { "type": "string", "description": "Line item hash for change detection" }, "currency": { "type": "string", "description": "Currency code" }, "total_price": { "type": "number", "format": "double", "description": "Total price" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "presentment_currency_code": { "type": ["string", "null"], "description": "Presentment currency code" }, "subtotal_price": { "type": "number", "format": "double", "description": "Subtotal price" }, "invoice_email_template_subject": { "type": ["string", "null"], "description": "Invoice email template subject" }, "market_name": { "type": ["string", "null"], "description": "Market name" }, "market_region_country_code": { "type": ["string", "null"], "description": "Market region country code" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address address1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address address2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address address1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address address2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "notes": { "type": ["string", "null"], "description": "Notes" }, "config": { "description": "Order-level configuration overrides that carry forward when converted", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "po_number": { "type": ["string", "null"], "description": "Purchase order number for B2B" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID (external system)" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the draft order was last synced" }, "invoice_url": { "type": ["string", "null"], "description": "Invoice URL" }, "invoice_sent_at": { "type": ["string", "null"], "format": "date-time", "description": "When invoice was sent" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When draft order was completed" }, "ready": { "type": "boolean", "description": "Ready for conversion (async operations complete)" }, "visible_to_customer": { "type": "boolean", "description": "Visible to customer" }, "customer_email": { "type": ["string", "null"], "description": "Customer email (consistent with Order schema)" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone (consistent with Order schema)" }, "customer_name": { "type": ["string", "null"], "description": "Customer name (consistent with Order schema)" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the order should be delivered to the customer" }, "tax_exempt": { "type": "boolean", "description": "Customer tax exempt" }, "taxes_included": { "type": "boolean", "description": "Taxes included in prices" }, "accept_automatic_discounts": { "type": "boolean", "description": "Accept automatic discounts" }, "allow_discount_codes_in_checkout": { "type": "boolean", "description": "Allow discount codes in checkout" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When reservations expire" }, "payment_terms_type": { "description": "Payment terms type", "type": ["string", "null"], "enum": ["FIXED", "FULFILLMENT", "NET", "RECEIPT", "UNKNOWN"] }, "payment_terms_name": { "type": ["string", "null"], "description": "Payment terms name" }, "payment_terms_due_in_days": { "type": ["number", "null"], "format": "double", "description": "Payment terms due in days" }, "shop_id": { "type": "string", "description": "Shop ID" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this draft order" }, "team_id": { "type": "string", "deprecated": true }, "order_id": { "type": ["string", "null"], "description": "Linked order ID" }, "shop_name": { "type": "string", "description": "Shop name (denormalized)" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type (denormalized)" }, "shop_slug": { "type": ["string", "null"], "description": "Shop slug (denormalized)" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this draft order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" } }, "required": [ "id", "created_at", "updated_at", "status", "draft_number", "line_item_hash", "currency", "total_price", "total_tax", "total_discount", "total_shipping", "total_outstanding", "presentment_currency_code", "subtotal_price", "invoice_email_template_subject", "market_name", "market_region_country_code", "shipping_address_name", "shipping_address_phone", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_zip", "shipping_address_country", "billing_address_name", "billing_address_phone", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_zip", "billing_address_country", "notes", "config", "po_number", "remote_id", "synced_at", "invoice_url", "invoice_sent_at", "completed_at", "ready", "visible_to_customer", "customer_email", "customer_phone", "customer_name", "deliver_by", "tax_exempt", "taxes_included", "accept_automatic_discounts", "allow_discount_codes_in_checkout", "reserved_inventory_until", "payment_terms_type", "payment_terms_name", "payment_terms_due_in_days", "shop_id", "merchant_team_id", "team_id", "order_id", "shop_name", "shop_type", "shop_slug", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "tags", "core_line_item_count", "unique_core_line_item_count" ], "type": "object", "additionalProperties": false }, "APIMinimalDraftOrderWithActions": { "description": "API DraftOrder used in get/get-many requests, with supported actions", "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "When the draft order was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "When the draft order was last updated" }, "status": { "$ref": "#/components/schemas/APIDraftOrderStatus", "description": "Status of the draft order" }, "draft_number": { "type": "string", "description": "Draft order number" }, "line_item_hash": { "type": "string", "description": "Line item hash for change detection" }, "currency": { "type": "string", "description": "Currency code" }, "total_price": { "type": "number", "format": "double", "description": "Total price" }, "total_tax": { "type": "number", "format": "double", "description": "Total tax" }, "total_discount": { "type": "number", "format": "double", "description": "Total discount" }, "total_shipping": { "type": "number", "format": "double", "description": "Total shipping" }, "total_outstanding": { "type": "number", "format": "double", "description": "Total outstanding" }, "presentment_currency_code": { "type": ["string", "null"], "description": "Presentment currency code" }, "subtotal_price": { "type": "number", "format": "double", "description": "Subtotal price" }, "invoice_email_template_subject": { "type": ["string", "null"], "description": "Invoice email template subject" }, "market_name": { "type": ["string", "null"], "description": "Market name" }, "market_region_country_code": { "type": ["string", "null"], "description": "Market region country code" }, "shipping_address_name": { "type": ["string", "null"], "description": "Shipping address name" }, "shipping_address_phone": { "type": ["string", "null"], "description": "Shipping address phone" }, "shipping_address_company": { "type": ["string", "null"], "description": "Shipping address company" }, "shipping_address_address1": { "type": ["string", "null"], "description": "Shipping address address1" }, "shipping_address_address2": { "type": ["string", "null"], "description": "Shipping address address2" }, "shipping_address_city": { "type": ["string", "null"], "description": "Shipping address city" }, "shipping_address_state": { "type": ["string", "null"], "description": "Shipping address state (e.g., \"CA\" for California)" }, "shipping_address_zip": { "type": ["string", "null"], "description": "Shipping address zip" }, "shipping_address_country": { "type": ["string", "null"], "description": "Shipping address country (ISO 3166-1 alpha-2 code)" }, "billing_address_name": { "type": ["string", "null"], "description": "Billing address name" }, "billing_address_phone": { "type": ["string", "null"], "description": "Billing address phone" }, "billing_address_company": { "type": ["string", "null"], "description": "Billing address company" }, "billing_address_address1": { "type": ["string", "null"], "description": "Billing address address1" }, "billing_address_address2": { "type": ["string", "null"], "description": "Billing address address2" }, "billing_address_city": { "type": ["string", "null"], "description": "Billing address city" }, "billing_address_state": { "type": ["string", "null"], "description": "Billing address state (e.g., \"CA\" for California)" }, "billing_address_zip": { "type": ["string", "null"], "description": "Billing address zip" }, "billing_address_country": { "type": ["string", "null"], "description": "Billing address country (ISO 3166-1 alpha-2 code)" }, "notes": { "type": ["string", "null"], "description": "Notes" }, "config": { "description": "Order-level configuration overrides that carry forward when converted", "oneOf": [ { "$ref": "#/components/schemas/APIOrderConfig" }, { "type": "null" } ] }, "po_number": { "type": ["string", "null"], "description": "Purchase order number for B2B" }, "remote_id": { "type": ["string", "null"], "description": "Remote ID (external system)" }, "synced_at": { "type": ["string", "null"], "format": "date-time", "description": "When the draft order was last synced" }, "invoice_url": { "type": ["string", "null"], "description": "Invoice URL" }, "invoice_sent_at": { "type": ["string", "null"], "format": "date-time", "description": "When invoice was sent" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "description": "When draft order was completed" }, "ready": { "type": "boolean", "description": "Ready for conversion (async operations complete)" }, "visible_to_customer": { "type": "boolean", "description": "Visible to customer" }, "customer_email": { "type": ["string", "null"], "description": "Customer email (consistent with Order schema)" }, "customer_phone": { "type": ["string", "null"], "description": "Customer phone (consistent with Order schema)" }, "customer_name": { "type": ["string", "null"], "description": "Customer name (consistent with Order schema)" }, "deliver_by": { "type": ["string", "null"], "format": "date-time", "description": "Target date by which the order should be delivered to the customer" }, "tax_exempt": { "type": "boolean", "description": "Customer tax exempt" }, "taxes_included": { "type": "boolean", "description": "Taxes included in prices" }, "accept_automatic_discounts": { "type": "boolean", "description": "Accept automatic discounts" }, "allow_discount_codes_in_checkout": { "type": "boolean", "description": "Allow discount codes in checkout" }, "reserved_inventory_until": { "type": ["string", "null"], "format": "date-time", "description": "When reservations expire" }, "payment_terms_type": { "description": "Payment terms type", "type": ["string", "null"], "enum": ["FIXED", "FULFILLMENT", "NET", "RECEIPT", "UNKNOWN"] }, "payment_terms_name": { "type": ["string", "null"], "description": "Payment terms name" }, "payment_terms_due_in_days": { "type": ["number", "null"], "format": "double", "description": "Payment terms due in days" }, "shop_id": { "type": "string", "description": "Shop ID" }, "merchant_team_id": { "type": "string", "description": "ID of the merchant team that owns this draft order" }, "team_id": { "type": "string", "deprecated": true }, "order_id": { "type": ["string", "null"], "description": "Linked order ID" }, "shop_name": { "type": "string", "description": "Shop name (denormalized)" }, "shop_type": { "$ref": "#/components/schemas/APIShopType", "description": "Shop type (denormalized)" }, "shop_slug": { "type": ["string", "null"], "description": "Shop slug (denormalized)" }, "merchant_team_name": { "type": "string", "description": "Merchant team name" }, "team_name": { "type": "string", "deprecated": true }, "fulfiller_team_id": { "type": "string", "description": "ID of the fulfiller team responsible for fulfilling this draft order" }, "fulfiller_team_name": { "type": "string", "description": "Fulfiller team name" }, "tags": { "items": { "type": "string" }, "type": "array", "description": "Tags" }, "core_line_item_count": { "type": "number", "format": "double", "description": "Total quantity of core line items (sum of quantities, denormalized for performance)" }, "unique_core_line_item_count": { "type": "number", "format": "double", "description": "Number of unique core line items (denormalized for performance)" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_DraftOrderSupportedActionType_" }, "type": "array", "description": "Supported actions for this draft order" } }, "required": [ "id", "created_at", "updated_at", "status", "draft_number", "line_item_hash", "currency", "total_price", "total_tax", "total_discount", "total_shipping", "total_outstanding", "presentment_currency_code", "subtotal_price", "invoice_email_template_subject", "market_name", "market_region_country_code", "shipping_address_name", "shipping_address_phone", "shipping_address_company", "shipping_address_address1", "shipping_address_address2", "shipping_address_city", "shipping_address_state", "shipping_address_zip", "shipping_address_country", "billing_address_name", "billing_address_phone", "billing_address_company", "billing_address_address1", "billing_address_address2", "billing_address_city", "billing_address_state", "billing_address_zip", "billing_address_country", "notes", "config", "po_number", "remote_id", "synced_at", "invoice_url", "invoice_sent_at", "completed_at", "ready", "visible_to_customer", "customer_email", "customer_phone", "customer_name", "deliver_by", "tax_exempt", "taxes_included", "accept_automatic_discounts", "allow_discount_codes_in_checkout", "reserved_inventory_until", "payment_terms_type", "payment_terms_name", "payment_terms_due_in_days", "shop_id", "merchant_team_id", "team_id", "order_id", "shop_name", "shop_type", "shop_slug", "merchant_team_name", "team_name", "fulfiller_team_id", "fulfiller_team_name", "tags", "core_line_item_count", "unique_core_line_item_count", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIGetManyDraftOrdersResponse": { "description": "Response for getting multiple orders", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalDraftOrderWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "ChargeSupportedActionType": { "enum": ["VIEW_CHARGE", "UPDATE_CHARGE", "REMOVE_CHARGE_FROM_INVOICE", "DELETE_CHARGE"], "type": "string" }, "APISupportedAction_ChargeSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/ChargeSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIChargeCategory": { "type": "string", "enum": [ "STORAGE", "SHIPPING", "AD_HOC", "PICKING", "MATERIALS", "CREDIT", "RETURN_INSPECTION", "LABOR", "RECEIVING", "SHIPPING_CORRECTION" ] }, "ChargeOrigination": { "enum": ["ORDER", "RETURN", "WORK_ORDER", "PURCHASE_ORDER"], "type": "string" }, "CarrierType": { "type": "string", "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "ShopType": { "type": "string", "enum": ["SHOPIFY", "MAGENTO2", "BIGCOMMERCE", "MANUAL", "WOOCOMMERCE", "WIX", "TIKTOK"] }, "OrderPriority": { "type": "string", "enum": ["LOW", "NORMAL", "HIGH", "CRITICAL"] }, "AddressResidentialType": { "type": "string", "enum": ["UNKNOWN", "RESIDENTIAL", "COMMERCIAL"] }, "ChargeShippingPricingConfig": { "properties": { "category": { "type": "string", "enum": ["SHIPPING"], "nullable": false }, "original_amount": { "type": "number", "format": "double" }, "origination": { "$ref": "#/components/schemas/ChargeOrigination" }, "shipping_label": { "properties": { "from_address_country": { "type": "string", "nullable": true }, "from_address_zip": { "type": "string", "nullable": true }, "from_address_state": { "type": "string", "nullable": true }, "from_address_city": { "type": "string", "nullable": true }, "to_address_country": { "type": "string", "nullable": true }, "to_address_zip": { "type": "string", "nullable": true }, "to_address_state": { "type": "string", "nullable": true }, "to_address_city": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "formatted_service": { "type": "string", "nullable": true }, "carrier_integration_name": { "type": "string", "nullable": true }, "carrier_integration_type": { "allOf": [ { "$ref": "#/components/schemas/CarrierType" } ], "nullable": true }, "tracking_code": { "type": "string", "nullable": true } }, "required": [ "from_address_country", "from_address_zip", "from_address_state", "from_address_city", "to_address_country", "to_address_zip", "to_address_state", "to_address_city", "zone", "price", "formatted_service", "carrier_integration_name", "carrier_integration_type" ], "type": "object" }, "order": { "type": ["object", "null"], "properties": { "address_residential": { "allOf": [ { "$ref": "#/components/schemas/AddressResidentialType" } ], "nullable": true }, "priority": { "$ref": "#/components/schemas/OrderPriority" }, "is_fragile": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "unique_core_line_item_count": { "type": "number", "format": "double" }, "shop_type": { "allOf": [ { "$ref": "#/components/schemas/ShopType" } ], "nullable": true }, "order_number": { "type": "string", "nullable": true } }, "required": [ "address_residential", "priority", "is_fragile", "tags", "unique_core_line_item_count", "shop_type", "order_number" ] } }, "required": ["category", "original_amount", "origination", "shipping_label", "order"], "type": "object", "additionalProperties": false }, "PickedItem": { "properties": { "product_id": { "type": ["string", "null"] }, "sku": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantity_eaches": { "type": "number", "format": "double" }, "uom_profile_id": { "type": ["string", "null"] }, "uom_label": { "type": ["string", "null"] }, "uom_multiplier_to_eaches": { "type": ["number", "null"], "format": "double" } }, "required": ["product_id", "sku", "name", "quantity"], "type": "object", "additionalProperties": false }, "ChargePickingPricingConfig": { "properties": { "category": { "type": "string", "enum": ["PICKING"], "nullable": false }, "eaches_picked": { "type": "number", "format": "double" }, "uoms_picked": { "type": "number", "format": "double" }, "unique_skus_picked": { "type": "number", "format": "double" }, "order": { "type": ["object", "null"], "properties": { "priority": { "$ref": "#/components/schemas/OrderPriority" }, "is_fragile": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "core_line_item_count": { "type": "number", "format": "double" }, "unique_core_line_item_count": { "type": "number", "format": "double" }, "shop_type": { "allOf": [ { "$ref": "#/components/schemas/ShopType" } ], "nullable": true }, "order_number": { "type": "string", "nullable": true } }, "required": [ "priority", "is_fragile", "tags", "core_line_item_count", "unique_core_line_item_count", "shop_type", "order_number" ] }, "picked_items": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/PickedItem" } } }, "required": ["category", "eaches_picked", "uoms_picked", "unique_skus_picked", "order", "picked_items"], "type": "object", "additionalProperties": false }, "RatePeriod": { "type": "string", "enum": ["DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY", "YEARLY"] }, "ChargeStoragePricingConfig": { "properties": { "category": { "type": "string", "enum": ["STORAGE"], "nullable": false }, "number_of_locations": { "type": "number", "format": "double" }, "days": { "type": "number", "format": "double" }, "rate_period": { "$ref": "#/components/schemas/RatePeriod" }, "warehouse": { "type": ["object", "null"], "properties": { "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "required": ["state", "country"] } }, "required": ["category", "number_of_locations", "days", "rate_period", "warehouse"], "type": "object", "additionalProperties": false }, "MeasurementUnit": { "type": "string", "enum": ["MM", "CM", "M", "IN", "FT"] }, "WeightUnit": { "type": "string", "enum": ["G", "KG", "OZ", "LB"] }, "ChargeMaterialsPricingConfig": { "properties": { "category": { "type": "string", "enum": ["MATERIALS"], "nullable": false }, "quantity": { "type": "number", "format": "double" }, "carton": { "properties": { "weight_unit": { "allOf": [ { "$ref": "#/components/schemas/WeightUnit" } ], "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "measurement_unit": { "allOf": [ { "$ref": "#/components/schemas/MeasurementUnit" } ], "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true } }, "required": ["weight_unit", "weight", "measurement_unit", "height", "width", "length"], "type": "object" } }, "required": ["category", "quantity", "carton"], "type": "object", "additionalProperties": false }, "ReturnType": { "type": "string", "enum": ["RETURN_TO_SENDER", "MANUAL", "CUSTOMER_RETURN", "WARRANTY", "EXCHANGE"] }, "ChargeReturnInspectionPricingConfig": { "properties": { "category": { "type": "string", "enum": ["RETURN_INSPECTION"], "nullable": false }, "units_inspected": { "type": "number", "format": "double" }, "return": { "type": ["object", "null"], "properties": { "received_items_count": { "type": "number", "format": "double" }, "expected_items_count": { "type": "number", "format": "double" }, "return_type": { "$ref": "#/components/schemas/ReturnType" } }, "required": ["received_items_count", "expected_items_count", "return_type"] }, "order": { "type": ["object", "null"], "properties": { "tags": { "items": { "type": "string" }, "type": "array" }, "shop_type": { "allOf": [ { "$ref": "#/components/schemas/ShopType" } ], "nullable": true }, "order_number": { "type": "string", "nullable": true } }, "required": ["tags", "shop_type", "order_number"] } }, "required": ["category", "units_inspected", "return", "order"], "type": "object", "additionalProperties": false }, "ChargeReceivingPricingConfig": { "properties": { "category": { "type": "string", "enum": ["RECEIVING"], "nullable": false }, "units_received": { "type": "number", "format": "double" }, "purchase_order": { "properties": { "name": { "type": "string", "nullable": true } }, "required": ["name"], "type": "object" }, "warehouse": { "type": ["object", "null"], "properties": { "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "required": ["state", "country"] } }, "required": ["category", "units_received", "purchase_order", "warehouse"], "type": "object", "additionalProperties": false }, "CarrierCorrectionPricingMethod": { "type": "string", "enum": ["ORIGINAL_MULTIPLIER", "CUSTOM_MULTIPLIER", "PASSTHROUGH", "MANUAL_OVERRIDE"] }, "ChargeShippingCorrectionPricingConfig": { "properties": { "category": { "type": "string", "enum": ["SHIPPING_CORRECTION"], "nullable": false }, "provider": { "$ref": "#/components/schemas/CarrierCorrectionProvider" }, "carrier_invoice_number": { "type": "string" }, "transaction_date": { "type": ["string", "null"], "description": "ISO YYYY-MM-DD calendar date; pricing_config is JSON and must not introduce a timezone." }, "tracking_number": { "type": "string" }, "correction_type": { "type": ["string", "null"] }, "correction_reason": { "type": ["string", "null"] }, "carrier_adjustment_amount": { "type": "number", "format": "double" }, "multiplier": { "type": "number", "format": "double" }, "merchant_adjustment_amount": { "type": "number", "format": "double" }, "pricing_method": { "$ref": "#/components/schemas/CarrierCorrectionPricingMethod" }, "manual_override_reason": { "type": ["string", "null"] }, "import_provenance": { "type": ["object", "null"], "properties": { "shipping_label": { "properties": { "from_address_country": { "type": "string", "nullable": true }, "from_address_zip": { "type": "string", "nullable": true }, "from_address_state": { "type": "string", "nullable": true }, "from_address_city": { "type": "string", "nullable": true }, "to_address_country": { "type": "string", "nullable": true }, "to_address_zip": { "type": "string", "nullable": true }, "to_address_state": { "type": "string", "nullable": true }, "to_address_city": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "formatted_service": { "type": "string", "nullable": true }, "carrier_integration_name": { "type": "string", "nullable": true }, "carrier_integration_type": { "allOf": [ { "$ref": "#/components/schemas/CarrierType" } ], "nullable": true } }, "required": [ "from_address_country", "from_address_zip", "from_address_state", "from_address_city", "to_address_country", "to_address_zip", "to_address_state", "to_address_city", "zone", "formatted_service", "carrier_integration_name", "carrier_integration_type" ], "type": "object" }, "original_shipping_charge_id": { "type": "string", "nullable": true }, "line_id": { "type": "string" }, "import_id": { "type": "string" }, "format": { "$ref": "#/components/schemas/CarrierCorrectionFormat" } }, "required": ["shipping_label", "original_shipping_charge_id", "line_id", "import_id", "format"] } }, "required": [ "category", "provider", "carrier_invoice_number", "transaction_date", "tracking_number", "correction_type", "correction_reason", "carrier_adjustment_amount", "multiplier", "merchant_adjustment_amount", "pricing_method", "manual_override_reason", "import_provenance" ], "type": "object", "additionalProperties": false }, "ChargeCreditPricingConfig": { "properties": { "category": { "type": "string", "enum": ["CREDIT"], "nullable": false }, "amount": { "type": "number", "format": "double" }, "reason": { "type": ["string", "null"] } }, "required": ["category", "amount", "reason"], "type": "object", "additionalProperties": false }, "ChargeAdHocPricingConfig": { "properties": { "category": { "type": "string", "enum": ["AD_HOC"], "nullable": false }, "amount": { "type": "number", "format": "double" } }, "required": ["category", "amount"], "type": "object", "additionalProperties": false }, "LaborActivityKind": { "type": "string", "enum": ["WORK", "BREAK", "LUNCH", "CALL_OUT", "NO_SHOW"] }, "PowerRole": { "type": "string", "enum": ["OWNER", "ADMIN", "MEMBER"] }, "LaborJobType": { "type": "string", "enum": [ "CUSTOM", "BULK_SHIP", "PICKING", "RECEIVING", "PACKING", "CYCLE_COUNTING", "PUT_AWAY", "REPLENISHMENT", "SORTING", "WATER_SPIDER", "WORK_ORDERS" ] }, "ChargeLaborPricingConfig": { "properties": { "category": { "type": "string", "enum": ["LABOR"], "nullable": false }, "source": { "type": "string", "enum": ["WORK_ORDER", "PURCHASE_ORDER", "MANUAL"] }, "duration_minutes": { "type": "number", "format": "double" }, "actual_hours": { "type": "number", "format": "double" }, "billable_hours": { "type": "number", "format": "double" }, "billing_rounding_minutes": { "type": "number", "format": "double" }, "billing_rounding_mode": { "$ref": "#/components/schemas/LaborBillingRoundingMode" }, "rounded_billable_minutes": { "type": "number", "format": "double" }, "started_at": { "type": ["string", "null"] }, "ended_at": { "type": ["string", "null"] }, "kind": { "$ref": "#/components/schemas/LaborActivityKind" }, "worker": { "type": ["object", "null"], "properties": { "roles": { "items": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": ["name", "id"], "type": "object" }, "type": "array" }, "power_role": { "$ref": "#/components/schemas/PowerRole" }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string" } }, "required": ["roles", "power_role", "email", "name", "id"] }, "labor_job": { "type": ["object", "null"], "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/LaborJobType" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "required": ["type", "name", "id"] }, "warehouse": { "type": ["object", "null"], "properties": { "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "required": ["state", "country", "name", "id"] } }, "required": [ "category", "source", "duration_minutes", "actual_hours", "billable_hours", "billing_rounding_minutes", "billing_rounding_mode", "rounded_billable_minutes", "started_at", "ended_at", "kind", "worker", "labor_job", "warehouse" ], "type": "object", "additionalProperties": false }, "ChargePricingConfig": { "anyOf": [ { "$ref": "#/components/schemas/ChargeShippingPricingConfig" }, { "$ref": "#/components/schemas/ChargePickingPricingConfig" }, { "$ref": "#/components/schemas/ChargeStoragePricingConfig" }, { "$ref": "#/components/schemas/ChargeMaterialsPricingConfig" }, { "$ref": "#/components/schemas/ChargeReturnInspectionPricingConfig" }, { "$ref": "#/components/schemas/ChargeReceivingPricingConfig" }, { "$ref": "#/components/schemas/ChargeShippingCorrectionPricingConfig" }, { "$ref": "#/components/schemas/ChargeCreditPricingConfig" }, { "$ref": "#/components/schemas/ChargeAdHocPricingConfig" }, { "$ref": "#/components/schemas/ChargeLaborPricingConfig" } ] }, "PricingTraceDecision": { "enum": ["pricing_matched", "no_trigger", "no_pricing_reached", "pricing_error"], "type": "string" }, "ShippingPricingConfig": { "properties": { "category": { "type": "string", "enum": ["SHIPPING"], "nullable": false }, "original_amount": { "type": "number", "format": "double" }, "origination": { "$ref": "#/components/schemas/ChargeOrigination" }, "shipping_label": { "properties": { "from_address_country": { "type": "string", "nullable": true }, "from_address_zip": { "type": "string", "nullable": true }, "from_address_state": { "type": "string", "nullable": true }, "from_address_city": { "type": "string", "nullable": true }, "to_address_country": { "type": "string", "nullable": true }, "to_address_zip": { "type": "string", "nullable": true }, "to_address_state": { "type": "string", "nullable": true }, "to_address_city": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "formatted_service": { "type": "string", "nullable": true }, "service_id": { "type": "string", "nullable": true }, "carrier_integration_name": { "type": "string", "nullable": true }, "carrier_integration_type": { "allOf": [ { "$ref": "#/components/schemas/CarrierType" } ], "nullable": true }, "carrier_integration_id": { "type": "string", "nullable": true }, "carrier_id": { "type": "string", "nullable": true }, "tracking_code": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "required": [ "from_address_country", "from_address_zip", "from_address_state", "from_address_city", "to_address_country", "to_address_zip", "to_address_state", "to_address_city", "zone", "price", "formatted_service", "service_id", "carrier_integration_name", "carrier_integration_type", "carrier_integration_id", "carrier_id" ], "type": "object" }, "order": { "type": ["object", "null"], "properties": { "address_residential": { "allOf": [ { "$ref": "#/components/schemas/AddressResidentialType" } ], "nullable": true }, "priority": { "$ref": "#/components/schemas/OrderPriority" }, "is_fragile": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "unique_core_line_item_count": { "type": "number", "format": "double" }, "shop_type": { "allOf": [ { "$ref": "#/components/schemas/ShopType" } ], "nullable": true }, "order_number": { "type": "string", "nullable": true }, "id": { "type": "string" } }, "required": [ "address_residential", "priority", "is_fragile", "tags", "unique_core_line_item_count", "shop_type" ] } }, "required": ["category", "original_amount", "origination", "shipping_label", "order"], "type": "object", "additionalProperties": false }, "PickingPricingConfig": { "properties": { "category": { "type": "string", "enum": ["PICKING"], "nullable": false }, "eaches_picked": { "type": "number", "format": "double" }, "uoms_picked": { "type": "number", "format": "double" }, "unique_skus_picked": { "type": "number", "format": "double" }, "order": { "type": ["object", "null"], "properties": { "priority": { "$ref": "#/components/schemas/OrderPriority" }, "is_fragile": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "core_line_item_count": { "type": "number", "format": "double" }, "unique_core_line_item_count": { "type": "number", "format": "double" }, "shop_type": { "allOf": [ { "$ref": "#/components/schemas/ShopType" } ], "nullable": true }, "order_number": { "type": "string", "nullable": true }, "id": { "type": "string" } }, "required": [ "priority", "is_fragile", "tags", "core_line_item_count", "unique_core_line_item_count", "shop_type" ] }, "picked_items": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/PickedItem" } } }, "required": ["category", "eaches_picked", "uoms_picked", "unique_skus_picked", "order", "picked_items"], "type": "object", "additionalProperties": false }, "StoragePricingConfig": { "properties": { "category": { "type": "string", "enum": ["STORAGE"], "nullable": false }, "number_of_locations": { "type": "number", "format": "double" }, "days": { "type": "number", "format": "double" }, "rate_period": { "$ref": "#/components/schemas/RatePeriod" }, "location_type": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": ["name", "id"], "type": "object" }, "warehouse": { "type": ["object", "null"], "properties": { "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": ["state", "country", "name", "id"] } }, "required": ["category", "number_of_locations", "days", "rate_period", "location_type", "warehouse"], "type": "object", "additionalProperties": false }, "MaterialsPricingConfig": { "properties": { "category": { "type": "string", "enum": ["MATERIALS"], "nullable": false }, "quantity": { "type": "number", "format": "double" }, "carton": { "properties": { "weight_unit": { "allOf": [ { "$ref": "#/components/schemas/WeightUnit" } ], "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "measurement_unit": { "allOf": [ { "$ref": "#/components/schemas/MeasurementUnit" } ], "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": ["weight_unit", "weight", "measurement_unit", "height", "width", "length", "name", "id"], "type": "object" } }, "required": ["category", "quantity", "carton"], "type": "object", "additionalProperties": false }, "ReturnInspectionPricingConfig": { "properties": { "category": { "type": "string", "enum": ["RETURN_INSPECTION"], "nullable": false }, "units_inspected": { "type": "number", "format": "double" }, "return": { "type": ["object", "null"], "properties": { "received_items_count": { "type": "number", "format": "double" }, "expected_items_count": { "type": "number", "format": "double" }, "return_type": { "$ref": "#/components/schemas/ReturnType" }, "id": { "type": "string" } }, "required": ["received_items_count", "expected_items_count", "return_type"] }, "order": { "type": ["object", "null"], "properties": { "tags": { "items": { "type": "string" }, "type": "array" }, "shop_type": { "allOf": [ { "$ref": "#/components/schemas/ShopType" } ], "nullable": true }, "order_number": { "type": "string", "nullable": true }, "id": { "type": "string" } }, "required": ["tags", "shop_type", "id"] } }, "required": ["category", "units_inspected", "return", "order"], "type": "object", "additionalProperties": false }, "ReceivingPricingConfig": { "properties": { "category": { "type": "string", "enum": ["RECEIVING"], "nullable": false }, "units_received": { "type": "number", "format": "double" }, "purchase_order": { "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "string" } }, "required": ["name", "id"], "type": "object" }, "warehouse": { "type": ["object", "null"], "properties": { "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": ["state", "country", "name", "id"] } }, "required": ["category", "units_received", "purchase_order", "warehouse"], "type": "object", "additionalProperties": false }, "ShippingCorrectionPricingConfig": { "properties": { "category": { "type": "string", "enum": ["SHIPPING_CORRECTION"], "nullable": false }, "provider": { "$ref": "#/components/schemas/CarrierCorrectionProvider" }, "carrier_invoice_number": { "type": "string" }, "transaction_date": { "type": ["string", "null"], "description": "ISO YYYY-MM-DD calendar date; pricing_config is JSON and must not introduce a timezone." }, "tracking_number": { "type": "string" }, "correction_type": { "type": ["string", "null"] }, "correction_reason": { "type": ["string", "null"] }, "carrier_adjustment_amount": { "type": "number", "format": "double" }, "multiplier": { "type": "number", "format": "double" }, "merchant_adjustment_amount": { "type": "number", "format": "double" }, "pricing_method": { "$ref": "#/components/schemas/CarrierCorrectionPricingMethod" }, "manual_override_reason": { "type": ["string", "null"] }, "import_provenance": { "type": ["object", "null"], "properties": { "shipping_label": { "properties": { "from_address_country": { "type": "string", "nullable": true }, "from_address_zip": { "type": "string", "nullable": true }, "from_address_state": { "type": "string", "nullable": true }, "from_address_city": { "type": "string", "nullable": true }, "to_address_country": { "type": "string", "nullable": true }, "to_address_zip": { "type": "string", "nullable": true }, "to_address_state": { "type": "string", "nullable": true }, "to_address_city": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "formatted_service": { "type": "string", "nullable": true }, "carrier_integration_name": { "type": "string", "nullable": true }, "carrier_integration_type": { "allOf": [ { "$ref": "#/components/schemas/CarrierType" } ], "nullable": true } }, "required": [ "from_address_country", "from_address_zip", "from_address_state", "from_address_city", "to_address_country", "to_address_zip", "to_address_state", "to_address_city", "zone", "formatted_service", "carrier_integration_name", "carrier_integration_type" ], "type": "object" }, "original_shipping_charge_id": { "type": "string", "nullable": true }, "line_id": { "type": "string" }, "import_id": { "type": "string" }, "format": { "$ref": "#/components/schemas/CarrierCorrectionFormat" } }, "required": ["shipping_label", "original_shipping_charge_id", "line_id", "import_id", "format"] } }, "required": [ "category", "provider", "carrier_invoice_number", "transaction_date", "tracking_number", "correction_type", "correction_reason", "carrier_adjustment_amount", "multiplier", "merchant_adjustment_amount", "pricing_method", "manual_override_reason", "import_provenance" ], "type": "object", "additionalProperties": false }, "CreditPricingConfig": { "properties": { "category": { "type": "string", "enum": ["CREDIT"], "nullable": false }, "amount": { "type": "number", "format": "double" }, "reason": { "type": ["string", "null"] } }, "required": ["category", "amount", "reason"], "type": "object", "additionalProperties": false }, "AdHocPricingConfig": { "properties": { "category": { "type": "string", "enum": ["AD_HOC"], "nullable": false }, "amount": { "type": "number", "format": "double" } }, "required": ["category", "amount"], "type": "object", "additionalProperties": false }, "LaborPricingConfig": { "properties": { "category": { "type": "string", "enum": ["LABOR"], "nullable": false }, "source": { "type": "string", "enum": ["WORK_ORDER", "PURCHASE_ORDER", "MANUAL"] }, "duration_minutes": { "type": "number", "format": "double" }, "actual_hours": { "type": "number", "format": "double" }, "billable_hours": { "type": "number", "format": "double" }, "billing_rounding_minutes": { "type": "number", "format": "double" }, "billing_rounding_mode": { "$ref": "#/components/schemas/LaborBillingRoundingMode" }, "rounded_billable_minutes": { "type": "number", "format": "double" }, "started_at": { "type": ["string", "null"] }, "ended_at": { "type": ["string", "null"] }, "kind": { "$ref": "#/components/schemas/LaborActivityKind" }, "worker": { "type": ["object", "null"], "properties": { "roles": { "items": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": ["name", "id"], "type": "object" }, "type": "array" }, "power_role": { "$ref": "#/components/schemas/PowerRole" }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string" } }, "required": ["roles", "power_role", "email", "name", "id"] }, "labor_job": { "type": ["object", "null"], "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/LaborJobType" } ], "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "required": ["type", "name", "id"] }, "warehouse": { "type": ["object", "null"], "properties": { "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "required": ["state", "country", "name", "id"] } }, "required": [ "category", "source", "duration_minutes", "actual_hours", "billable_hours", "billing_rounding_minutes", "billing_rounding_mode", "rounded_billable_minutes", "started_at", "ended_at", "kind", "worker", "labor_job", "warehouse" ], "type": "object", "additionalProperties": false }, "PricingConfig": { "anyOf": [ { "$ref": "#/components/schemas/ShippingPricingConfig" }, { "$ref": "#/components/schemas/PickingPricingConfig" }, { "$ref": "#/components/schemas/StoragePricingConfig" }, { "$ref": "#/components/schemas/MaterialsPricingConfig" }, { "$ref": "#/components/schemas/ReturnInspectionPricingConfig" }, { "$ref": "#/components/schemas/ReceivingPricingConfig" }, { "$ref": "#/components/schemas/ShippingCorrectionPricingConfig" }, { "$ref": "#/components/schemas/CreditPricingConfig" }, { "$ref": "#/components/schemas/AdHocPricingConfig" }, { "$ref": "#/components/schemas/LaborPricingConfig" } ] }, "PricingTraceEventType.TRIGGER": { "enum": ["trigger"], "type": "string" }, "PricingTraceTriggerEvent": { "properties": { "event_type": { "$ref": "#/components/schemas/PricingTraceEventType.TRIGGER" }, "step_id": { "type": "string" }, "category": { "$ref": "#/components/schemas/APIChargeCategory" }, "matched": { "type": "boolean" } }, "required": ["event_type", "step_id", "category", "matched"], "type": "object", "additionalProperties": false }, "PricingTraceEventType.CONDITION": { "enum": ["condition"], "type": "string" }, "PricingTraceConditionEvent": { "properties": { "event_type": { "$ref": "#/components/schemas/PricingTraceEventType.CONDITION" }, "step_id": { "type": "string" }, "result": { "type": "boolean" }, "condition_variable": { "type": "string" }, "condition_value": {}, "actual_value": {}, "condition_operator": { "type": ["string", "null"] }, "logical_operator": { "type": ["string", "null"] }, "individual_conditions": { "items": { "properties": { "individual_conditions": { "items": {}, "type": "array" }, "logical_operator": { "type": "string" }, "condition_operator": { "type": "string" }, "expected_value": {}, "actual_value": {}, "passed": { "type": "boolean" }, "condition": { "type": "string" } }, "required": ["expected_value", "actual_value", "passed", "condition"], "type": "object" }, "type": "array" } }, "required": ["event_type", "step_id", "result", "condition_variable", "condition_value", "actual_value"], "type": "object", "additionalProperties": false }, "PricingTraceEventType.PRICING": { "enum": ["pricing"], "type": "string" }, "PickingOverrideProductBreakdown": { "properties": { "product_id": { "type": ["string", "null"] }, "sku": { "type": ["string", "null"] }, "name": { "type": ["string", "null"] }, "quantity": { "type": "number", "format": "double" }, "unit_cost": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" } }, "required": ["product_id", "sku", "name", "quantity", "unit_cost", "amount"], "type": "object", "additionalProperties": false }, "PickingProductOverrideAdjustment": { "properties": { "type": { "type": "string", "enum": ["PICKING_PRODUCT_OVERRIDES"], "nullable": false }, "standard_units": { "type": "number", "format": "double" }, "override_units": { "type": "number", "format": "double" }, "standard_amount": { "type": "number", "format": "double" }, "override_amount": { "type": "number", "format": "double" }, "subtotal_before_minimum": { "type": "number", "format": "double" }, "minimum_charge": { "type": ["number", "null"], "format": "double" }, "minimum_charge_applied": { "type": "boolean" }, "final_amount": { "type": "number", "format": "double" }, "rounding_method": { "type": "string", "enum": ["floor"], "nullable": false }, "override_products": { "items": { "$ref": "#/components/schemas/PickingOverrideProductBreakdown" }, "type": "array" } }, "required": [ "type", "standard_units", "override_units", "standard_amount", "override_amount", "subtotal_before_minimum", "minimum_charge", "minimum_charge_applied", "final_amount", "rounding_method", "override_products" ], "type": "object", "additionalProperties": false }, "PricingTraceAdjustment": { "$ref": "#/components/schemas/PickingProductOverrideAdjustment" }, "PricingTracePricingEventBase": { "properties": { "event_type": { "$ref": "#/components/schemas/PricingTraceEventType.PRICING" }, "step_id": { "type": "string" }, "node_type": { "type": "string", "enum": ["PRICING"], "nullable": false }, "category": { "$ref": "#/components/schemas/APIChargeCategory" }, "calculated_amount": { "type": "number", "format": "double" }, "calculation_note": { "type": ["string", "null"] }, "adjustments": { "items": { "$ref": "#/components/schemas/PricingTraceAdjustment" }, "type": "array" } }, "required": ["event_type", "step_id", "node_type", "category", "calculated_amount", "calculation_note"], "type": "object", "additionalProperties": false }, "FixedAuditDetails": { "properties": { "fee_structure": { "type": "string", "enum": ["FIXED"], "nullable": false }, "details": { "properties": { "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" }, "rate_days": { "type": "number", "format": "double" }, "charge_days": { "type": "number", "format": "double" }, "charge_rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "cost": { "type": "number", "format": "double" } }, "required": ["cost"], "type": "object" } }, "required": ["fee_structure", "details"], "type": "object", "additionalProperties": false }, "VariableAuditDetails": { "properties": { "fee_structure": { "type": "string", "enum": ["VARIABLE"], "nullable": false }, "details": { "properties": { "minimum_charge_applied": { "type": "boolean" }, "pre_minimum_amount": { "type": "number", "format": "double" }, "minimum_charge": { "type": "number", "format": "double", "nullable": true }, "rate_days": { "type": "number", "format": "double" }, "charge_days": { "type": "number", "format": "double" }, "charge_rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "resolved_rate": { "type": "number", "format": "double" }, "rate_path": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" } }, "required": ["cost", "resolved_quantity", "quantity_path"], "type": "object" } }, "required": ["fee_structure", "details"], "type": "object", "additionalProperties": false }, "VariableWithAllowanceAuditDetails": { "properties": { "fee_structure": { "type": "string", "enum": ["VARIABLE_WITH_ALLOWANCE"], "nullable": false }, "details": { "properties": { "minimum_charge_applied": { "type": "boolean" }, "pre_minimum_amount": { "type": "number", "format": "double" }, "additional_amount": { "type": "number", "format": "double" }, "additional_units": { "type": "number", "format": "double" }, "included_amount": { "type": "number", "format": "double" }, "included_units": { "type": "number", "format": "double" }, "minimum_charge": { "type": "number", "format": "double", "nullable": true }, "additional_cost": { "type": "number", "format": "double" }, "base_cost": { "type": "number", "format": "double" }, "allowance": { "type": "number", "format": "double" }, "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" } }, "required": [ "minimum_charge", "additional_cost", "base_cost", "allowance", "resolved_quantity", "quantity_path" ], "type": "object" } }, "required": ["fee_structure", "details"], "type": "object", "additionalProperties": false }, "MultiplierAuditDetails": { "properties": { "fee_structure": { "type": "string", "enum": ["MULTIPLIER"], "nullable": false }, "details": { "properties": { "multiplier": { "type": "number", "format": "double" }, "resolved_base_amount": { "type": "number", "format": "double" }, "base_amount_path": { "type": "string" } }, "required": ["multiplier", "resolved_base_amount", "base_amount_path"], "type": "object" } }, "required": ["fee_structure", "details"], "type": "object", "additionalProperties": false }, "PricingTraceTier": { "properties": { "min": { "type": "number", "format": "double" }, "max": { "type": ["number", "null"], "format": "double" }, "cost": { "type": "number", "format": "double" } }, "required": ["min", "max", "cost"], "type": "object", "additionalProperties": false }, "PricingTraceTierBreakdown": { "properties": { "min": { "type": "number", "format": "double" }, "max": { "type": ["number", "null"], "format": "double" }, "cost": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" } }, "required": ["min", "max", "cost", "units", "amount"], "type": "object", "additionalProperties": false }, "GraduatedAuditDetails": { "properties": { "fee_structure": { "type": "string", "enum": ["GRADUATED"], "nullable": false }, "details": { "properties": { "minimum_charge_applied": { "type": "boolean" }, "pre_minimum_amount": { "type": "number", "format": "double" }, "over_threshold_amount": { "type": "number", "format": "double" }, "over_threshold_units": { "type": "number", "format": "double" }, "tier_breakdown": { "items": { "$ref": "#/components/schemas/PricingTraceTierBreakdown" }, "type": "array" }, "minimum_charge": { "type": "number", "format": "double", "nullable": true }, "over_threshold_cost": { "type": "number", "format": "double", "nullable": true }, "tiers": { "items": { "$ref": "#/components/schemas/PricingTraceTier" }, "type": "array" }, "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" } }, "required": ["tiers", "resolved_quantity", "quantity_path"], "type": "object" } }, "required": ["fee_structure", "details"], "type": "object", "additionalProperties": false }, "SelectedPricingDetails": { "anyOf": [ { "properties": { "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" }, "rate_days": { "type": "number", "format": "double" }, "charge_days": { "type": "number", "format": "double" }, "charge_rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "cost": { "type": "number", "format": "double" } }, "required": ["cost"], "type": "object" }, { "properties": { "minimum_charge_applied": { "type": "boolean" }, "pre_minimum_amount": { "type": "number", "format": "double" }, "minimum_charge": { "type": "number", "format": "double", "nullable": true }, "rate_days": { "type": "number", "format": "double" }, "charge_days": { "type": "number", "format": "double" }, "charge_rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "rate_period": { "$ref": "#/components/schemas/APIRatePeriod" }, "resolved_rate": { "type": "number", "format": "double" }, "rate_path": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" } }, "required": ["cost", "resolved_quantity", "quantity_path"], "type": "object" }, { "properties": { "minimum_charge_applied": { "type": "boolean" }, "pre_minimum_amount": { "type": "number", "format": "double" }, "additional_amount": { "type": "number", "format": "double" }, "additional_units": { "type": "number", "format": "double" }, "included_amount": { "type": "number", "format": "double" }, "included_units": { "type": "number", "format": "double" }, "minimum_charge": { "type": "number", "format": "double", "nullable": true }, "additional_cost": { "type": "number", "format": "double" }, "base_cost": { "type": "number", "format": "double" }, "allowance": { "type": "number", "format": "double" }, "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" } }, "required": [ "minimum_charge", "additional_cost", "base_cost", "allowance", "resolved_quantity", "quantity_path" ], "type": "object" }, { "properties": { "multiplier": { "type": "number", "format": "double" }, "resolved_base_amount": { "type": "number", "format": "double" }, "base_amount_path": { "type": "string" } }, "required": ["multiplier", "resolved_base_amount", "base_amount_path"], "type": "object" }, { "properties": { "minimum_charge_applied": { "type": "boolean" }, "pre_minimum_amount": { "type": "number", "format": "double" }, "over_threshold_amount": { "type": "number", "format": "double" }, "over_threshold_units": { "type": "number", "format": "double" }, "tier_breakdown": { "items": { "$ref": "#/components/schemas/PricingTraceTierBreakdown" }, "type": "array" }, "minimum_charge": { "type": "number", "format": "double", "nullable": true }, "over_threshold_cost": { "type": "number", "format": "double", "nullable": true }, "tiers": { "items": { "$ref": "#/components/schemas/PricingTraceTier" }, "type": "array" }, "resolved_quantity": { "type": "number", "format": "double" }, "quantity_path": { "type": "string" } }, "required": ["tiers", "resolved_quantity", "quantity_path"], "type": "object" }, { "properties": { "selected_pricing": { "$ref": "#/components/schemas/SelectedPricingDetails" }, "used_default": { "type": "boolean" }, "matched_key": { "type": "string", "nullable": true }, "resolved_key": { "type": "string" }, "evaluate_path": { "type": "string" } }, "required": ["selected_pricing", "used_default", "matched_key", "resolved_key", "evaluate_path"], "type": "object" } ] }, "MappedAuditDetails": { "properties": { "fee_structure": { "type": "string", "enum": ["MAPPED"], "nullable": false }, "details": { "properties": { "selected_pricing": { "$ref": "#/components/schemas/SelectedPricingDetails" }, "used_default": { "type": "boolean" }, "matched_key": { "type": "string", "nullable": true }, "resolved_key": { "type": "string" }, "evaluate_path": { "type": "string" } }, "required": ["selected_pricing", "used_default", "matched_key", "resolved_key", "evaluate_path"], "type": "object" } }, "required": ["fee_structure", "details"], "type": "object", "additionalProperties": false }, "PricingAuditDetails": { "anyOf": [ { "$ref": "#/components/schemas/FixedAuditDetails" }, { "$ref": "#/components/schemas/VariableAuditDetails" }, { "$ref": "#/components/schemas/VariableWithAllowanceAuditDetails" }, { "$ref": "#/components/schemas/MultiplierAuditDetails" }, { "$ref": "#/components/schemas/GraduatedAuditDetails" }, { "$ref": "#/components/schemas/MappedAuditDetails" } ] }, "PricingTracePricingEvent": { "allOf": [ { "$ref": "#/components/schemas/PricingTracePricingEventBase" }, { "$ref": "#/components/schemas/PricingAuditDetails" } ] }, "PricingTraceEvent": { "anyOf": [ { "$ref": "#/components/schemas/PricingTraceTriggerEvent" }, { "$ref": "#/components/schemas/PricingTraceConditionEvent" }, { "$ref": "#/components/schemas/PricingTracePricingEvent" } ] }, "PricingTrace": { "properties": { "rate_card_id": { "type": ["string", "null"] }, "rate_card_name": { "type": ["string", "null"] }, "version_id": { "type": ["string", "null"] }, "semantic_version": { "type": ["string", "null"] }, "category": { "$ref": "#/components/schemas/APIChargeCategory" }, "decision": { "$ref": "#/components/schemas/PricingTraceDecision" }, "trigger_step_id": { "type": ["string", "null"] }, "pricing_step_id": { "type": ["string", "null"] }, "calculated_amount": { "type": ["number", "null"], "format": "double" }, "calculation_note": { "type": ["string", "null"] }, "pricing_config": { "oneOf": [ { "$ref": "#/components/schemas/PricingConfig" }, { "type": "null" } ] }, "events": { "items": { "$ref": "#/components/schemas/PricingTraceEvent" }, "type": "array" } }, "required": [ "rate_card_id", "version_id", "semantic_version", "category", "decision", "trigger_step_id", "pricing_step_id", "calculated_amount", "calculation_note", "events" ], "type": "object", "additionalProperties": false }, "APIMinimalChargeWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "pricing_trace": { "description": "Structured audit trail for billing rule execution", "oneOf": [ { "$ref": "#/components/schemas/PricingTrace" }, { "type": "null" } ] }, "pricing_config": { "description": "Input payload used to calculate the charge", "oneOf": [ { "$ref": "#/components/schemas/ChargePricingConfig" }, { "type": "null" } ] }, "location_type_name": { "type": ["string", "null"], "description": "Location type name denormalized from location_type.name" }, "location_type_id": { "type": ["string", "null"], "description": "Location type id for storage charges" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name denormalized from warehouse.name" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse id for storage and receiving charges" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized from carton.name" }, "carton_id": { "type": ["string", "null"], "description": "Carton id for materials charges" }, "service_id": { "type": ["string", "null"], "description": "Service id for shipping charges" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name denormalized from carrier_integration.name" }, "carrier_integration_type": { "description": "Carrier integration type denormalized from carrier_integration.type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration id for shipping charges" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier id for shipping charges" }, "purchase_order_id": { "type": ["string", "null"], "description": "Tie to a purchase order for receiving charges" }, "shipping_label_id": { "type": ["string", "null"], "description": "Tie to a purchased label for label-based shipping charges" }, "return_id": { "type": ["string", "null"], "description": "Tie to a return for return-specific charges" }, "work_order_id": { "type": ["string", "null"], "description": "Tie to a work order for labor and ad-hoc work order charges" }, "order_id": { "type": ["string", "null"], "description": "Tie to an order for any order specific charges" }, "fulfillment_id": { "type": ["string", "null"], "description": "The fulfillment that the charge occurred in" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "The fulfillment order that the charge occurred in" }, "invoice_id": { "type": ["string", "null"], "description": "The invoice that this charge is associated with" }, "fulfillment_delegation_id": { "type": "string", "description": "The fulfillment delegation that this charge occurred between" }, "merchant_team_id": { "type": "string", "description": "The team that is being billed for the charge" }, "fulfiller_team_id": { "type": "string", "description": "The team that is billing for the charge" }, "quantity": { "type": ["number", "null"], "format": "double", "description": "Quantity of items for this charge" }, "calculated_amount": { "type": ["number", "null"], "format": "double", "description": "Final amount after rate card application" }, "original_amount": { "type": ["number", "null"], "format": "double", "description": "Original amount before rate card application" }, "currency": { "type": "string", "description": "Billing currency, denormalized from the fulfiller team" }, "category": { "$ref": "#/components/schemas/APIChargeCategory", "description": "The category of the charge" }, "description": { "type": ["string", "null"], "description": "Extra details about the charge" }, "name": { "type": "string", "description": "Descriptive name of the charge" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the charge was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the charge was created" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ChargeSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "pricing_trace", "pricing_config", "location_type_name", "location_type_id", "warehouse_name", "warehouse_id", "carton_name", "carton_id", "service_id", "carrier_integration_name", "carrier_integration_type", "carrier_integration_id", "carrier_id", "purchase_order_id", "shipping_label_id", "return_id", "work_order_id", "order_id", "fulfillment_id", "fulfillment_order_id", "invoice_id", "fulfillment_delegation_id", "merchant_team_id", "fulfiller_team_id", "quantity", "calculated_amount", "original_amount", "currency", "category", "description", "name", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIGetManyChargesResponse": { "description": "Response for getting multiple charges", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalChargeWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIExpandedChargeWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "pricing_trace": { "description": "Structured audit trail for billing rule execution", "oneOf": [ { "$ref": "#/components/schemas/PricingTrace" }, { "type": "null" } ] }, "pricing_config": { "description": "Input payload used to calculate the charge", "oneOf": [ { "$ref": "#/components/schemas/ChargePricingConfig" }, { "type": "null" } ] }, "location_type_name": { "type": ["string", "null"], "description": "Location type name denormalized from location_type.name" }, "location_type_id": { "type": ["string", "null"], "description": "Location type id for storage charges" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name denormalized from warehouse.name" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse id for storage and receiving charges" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized from carton.name" }, "carton_id": { "type": ["string", "null"], "description": "Carton id for materials charges" }, "service_id": { "type": ["string", "null"], "description": "Service id for shipping charges" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name denormalized from carrier_integration.name" }, "carrier_integration_type": { "description": "Carrier integration type denormalized from carrier_integration.type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration id for shipping charges" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier id for shipping charges" }, "purchase_order_id": { "type": ["string", "null"], "description": "Tie to a purchase order for receiving charges" }, "shipping_label_id": { "type": ["string", "null"], "description": "Tie to a purchased label for label-based shipping charges" }, "return_id": { "type": ["string", "null"], "description": "Tie to a return for return-specific charges" }, "work_order_id": { "type": ["string", "null"], "description": "Tie to a work order for labor and ad-hoc work order charges" }, "order_id": { "type": ["string", "null"], "description": "Tie to an order for any order specific charges" }, "fulfillment_id": { "type": ["string", "null"], "description": "The fulfillment that the charge occurred in" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "The fulfillment order that the charge occurred in" }, "invoice_id": { "type": ["string", "null"], "description": "The invoice that this charge is associated with" }, "fulfillment_delegation_id": { "type": "string", "description": "The fulfillment delegation that this charge occurred between" }, "merchant_team_id": { "type": "string", "description": "The team that is being billed for the charge" }, "fulfiller_team_id": { "type": "string", "description": "The team that is billing for the charge" }, "quantity": { "type": ["number", "null"], "format": "double", "description": "Quantity of items for this charge" }, "calculated_amount": { "type": ["number", "null"], "format": "double", "description": "Final amount after rate card application" }, "original_amount": { "type": ["number", "null"], "format": "double", "description": "Original amount before rate card application" }, "currency": { "type": "string", "description": "Billing currency, denormalized from the fulfiller team" }, "category": { "$ref": "#/components/schemas/APIChargeCategory", "description": "The category of the charge" }, "description": { "type": ["string", "null"], "description": "Extra details about the charge" }, "name": { "type": "string", "description": "Descriptive name of the charge" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the charge was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the charge was created" }, "id": { "type": "string", "description": "Unique identifier" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_ChargeSupportedActionType_" }, "type": "array", "description": "Supported actions" } }, "required": [ "pricing_trace", "pricing_config", "location_type_name", "location_type_id", "warehouse_name", "warehouse_id", "carton_name", "carton_id", "service_id", "carrier_integration_name", "carrier_integration_type", "carrier_integration_id", "carrier_id", "purchase_order_id", "shipping_label_id", "return_id", "work_order_id", "order_id", "fulfillment_id", "fulfillment_order_id", "invoice_id", "fulfillment_delegation_id", "merchant_team_id", "fulfiller_team_id", "quantity", "calculated_amount", "original_amount", "currency", "category", "description", "name", "updated_at", "created_at", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedCharge": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "pricing_trace": { "description": "Structured audit trail for billing rule execution", "oneOf": [ { "$ref": "#/components/schemas/PricingTrace" }, { "type": "null" } ] }, "pricing_config": { "description": "Input payload used to calculate the charge", "oneOf": [ { "$ref": "#/components/schemas/ChargePricingConfig" }, { "type": "null" } ] }, "location_type_name": { "type": ["string", "null"], "description": "Location type name denormalized from location_type.name" }, "location_type_id": { "type": ["string", "null"], "description": "Location type id for storage charges" }, "warehouse_name": { "type": ["string", "null"], "description": "Warehouse name denormalized from warehouse.name" }, "warehouse_id": { "type": ["string", "null"], "description": "Warehouse id for storage and receiving charges" }, "carton_name": { "type": ["string", "null"], "description": "Carton name denormalized from carton.name" }, "carton_id": { "type": ["string", "null"], "description": "Carton id for materials charges" }, "service_id": { "type": ["string", "null"], "description": "Service id for shipping charges" }, "carrier_integration_name": { "type": ["string", "null"], "description": "Carrier integration name denormalized from carrier_integration.name" }, "carrier_integration_type": { "description": "Carrier integration type denormalized from carrier_integration.type", "type": ["string", "null"], "enum": ["GENERIC", "EASYPOST", "USPS", "BUKUSHIP", "TIKTOK_SHIPPING"] }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration id for shipping charges" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier id for shipping charges" }, "purchase_order_id": { "type": ["string", "null"], "description": "Tie to a purchase order for receiving charges" }, "shipping_label_id": { "type": ["string", "null"], "description": "Tie to a purchased label for label-based shipping charges" }, "return_id": { "type": ["string", "null"], "description": "Tie to a return for return-specific charges" }, "work_order_id": { "type": ["string", "null"], "description": "Tie to a work order for labor and ad-hoc work order charges" }, "order_id": { "type": ["string", "null"], "description": "Tie to an order for any order specific charges" }, "fulfillment_id": { "type": ["string", "null"], "description": "The fulfillment that the charge occurred in" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "The fulfillment order that the charge occurred in" }, "invoice_id": { "type": ["string", "null"], "description": "The invoice that this charge is associated with" }, "fulfillment_delegation_id": { "type": "string", "description": "The fulfillment delegation that this charge occurred between" }, "merchant_team_id": { "type": "string", "description": "The team that is being billed for the charge" }, "fulfiller_team_id": { "type": "string", "description": "The team that is billing for the charge" }, "quantity": { "type": ["number", "null"], "format": "double", "description": "Quantity of items for this charge" }, "calculated_amount": { "type": ["number", "null"], "format": "double", "description": "Final amount after rate card application" }, "original_amount": { "type": ["number", "null"], "format": "double", "description": "Original amount before rate card application" }, "currency": { "type": "string", "description": "Billing currency, denormalized from the fulfiller team" }, "category": { "$ref": "#/components/schemas/APIChargeCategory", "description": "The category of the charge" }, "description": { "type": ["string", "null"], "description": "Extra details about the charge" }, "name": { "type": "string", "description": "Descriptive name of the charge" }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the charge was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the charge was created" }, "id": { "type": "string", "description": "Unique identifier" } }, "required": [ "pricing_trace", "pricing_config", "location_type_name", "location_type_id", "warehouse_name", "warehouse_id", "carton_name", "carton_id", "service_id", "carrier_integration_name", "carrier_integration_type", "carrier_integration_id", "carrier_id", "purchase_order_id", "shipping_label_id", "return_id", "work_order_id", "order_id", "fulfillment_id", "fulfillment_order_id", "invoice_id", "fulfillment_delegation_id", "merchant_team_id", "fulfiller_team_id", "quantity", "calculated_amount", "original_amount", "currency", "category", "description", "name", "updated_at", "created_at", "id" ], "type": "object", "additionalProperties": false }, "APICreateAdHocChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "original_amount": { "type": "number", "format": "double", "description": "Original amount" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" } }, "required": ["name", "original_amount"], "type": "object", "additionalProperties": false }, "APICreateAdHocChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (either this or merchant_team_id required)" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID (either this or fulfillment_delegation_id required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APICreateAdHocChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APICreateShippingChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "original_cost": { "type": "number", "format": "double", "description": "Original shipping cost" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID. Provide together with carrier_integration_id and service_id." }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID. Must be an active carrier integration owned by your team." }, "service_id": { "type": ["string", "null"], "description": "Service level ID. Must be enabled for the carrier on the given carrier integration." }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "fulfillment_id": { "type": ["string", "null"], "description": "Fulfillment ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID" } }, "required": ["name", "original_cost"], "type": "object", "additionalProperties": false }, "APICreateShippingChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (either this or merchant_team_id required)" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID (either this or fulfillment_delegation_id required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APICreateShippingChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APICreatePickingChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "picks": { "type": "number", "format": "double", "description": "Number of picks" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID" } }, "required": ["name", "picks"], "type": "object", "additionalProperties": false }, "APICreatePickingChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (either this or merchant_team_id required)" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID (either this or fulfillment_delegation_id required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APICreatePickingChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APICreateMaterialsChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "carton_id": { "type": "string", "description": "Carton ID" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "fulfillment_id": { "type": ["string", "null"], "description": "Fulfillment ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID" } }, "required": ["name", "carton_id", "quantity"], "type": "object", "additionalProperties": false }, "APICreateMaterialsChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (either this or merchant_team_id required)" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID (either this or fulfillment_delegation_id required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APICreateMaterialsChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APICreateStorageChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "location_type_id": { "type": "string", "description": "Location type ID" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "rate_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Rate period" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" } }, "required": ["name", "location_type_id", "warehouse_id", "rate_period", "quantity"], "type": "object", "additionalProperties": false }, "APICreateStorageChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (either this or merchant_team_id required)" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID (either this or fulfillment_delegation_id required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APICreateStorageChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APICreateCreditChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "amount": { "type": "number", "format": "double", "description": "Credit amount" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" } }, "required": ["name", "amount"], "type": "object", "additionalProperties": false }, "APICreateCreditChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (either this or merchant_team_id required)" }, "merchant_team_id": { "type": "string", "description": "Merchant team ID (either this or fulfillment_delegation_id required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APICreateCreditChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APICreateReturnInspectionChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "return_id": { "type": "string", "description": "Return ID" } }, "required": ["name", "quantity", "return_id"], "type": "object", "additionalProperties": false }, "APICreateReturnInspectionChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "data": { "$ref": "#/components/schemas/APICreateReturnInspectionChargeData", "description": "Charge data" } }, "required": ["fulfillment_delegation_id", "data"], "type": "object", "additionalProperties": false }, "APICreateReceivingChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "purchase_order_id": { "type": "string", "description": "Purchase order ID" } }, "required": ["name", "quantity", "purchase_order_id"], "type": "object", "additionalProperties": false }, "APICreateReceivingChargeInput": { "properties": { "fulfillment_delegation_id": { "type": "string", "description": "Fulfillment delegation ID (required)" }, "invoice_id": { "type": ["string", "null"], "description": "Invoice ID to attach the charge to" }, "data": { "$ref": "#/components/schemas/APICreateReceivingChargeData", "description": "Charge data" } }, "required": ["fulfillment_delegation_id", "data"], "type": "object", "additionalProperties": false }, "APIUpdateAdHocChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "original_amount": { "type": "number", "format": "double", "description": "Original amount" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" } }, "required": ["name", "original_amount"], "type": "object", "additionalProperties": false }, "APIUpdateAdHocChargeInput": { "properties": { "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APIUpdateAdHocChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdateShippingChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "original_cost": { "type": "number", "format": "double", "description": "Original shipping cost" }, "carrier_id": { "type": ["string", "null"], "description": "Carrier ID. Provide together with carrier_integration_id and service_id." }, "carrier_integration_id": { "type": ["string", "null"], "description": "Carrier integration ID. Must be an active carrier integration owned by your team." }, "service_id": { "type": ["string", "null"], "description": "Service level ID. Must be enabled for the carrier on the given carrier integration." }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "fulfillment_id": { "type": ["string", "null"], "description": "Fulfillment ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID" } }, "required": ["name", "original_cost"], "type": "object", "additionalProperties": false }, "APIUpdateShippingChargeInput": { "properties": { "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APIUpdateShippingChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdatePickingChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "picks": { "type": "number", "format": "double", "description": "Number of picks" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID" } }, "required": ["name", "picks"], "type": "object", "additionalProperties": false }, "APIUpdatePickingChargeInput": { "properties": { "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APIUpdatePickingChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdateMaterialsChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "carton_id": { "type": "string", "description": "Carton ID" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "fulfillment_order_id": { "type": ["string", "null"], "description": "Fulfillment order ID" }, "fulfillment_id": { "type": ["string", "null"], "description": "Fulfillment ID" }, "order_id": { "type": ["string", "null"], "description": "Order ID" } }, "required": ["name", "carton_id", "quantity"], "type": "object", "additionalProperties": false }, "APIUpdateMaterialsChargeInput": { "properties": { "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APIUpdateMaterialsChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdateStorageChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "location_type_id": { "type": "string", "description": "Location type ID" }, "warehouse_id": { "type": "string", "description": "Warehouse ID" }, "rate_period": { "$ref": "#/components/schemas/APIRatePeriod", "description": "Rate period" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" } }, "required": ["name", "location_type_id", "warehouse_id", "rate_period", "quantity"], "type": "object", "additionalProperties": false }, "APIUpdateStorageChargeInput": { "properties": { "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APIUpdateStorageChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdateCreditChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "amount": { "type": "number", "format": "double", "description": "Credit amount" }, "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" } }, "required": ["name", "amount"], "type": "object", "additionalProperties": false }, "APIUpdateCreditChargeInput": { "properties": { "order_id": { "type": "string", "description": "Order ID" }, "fulfillment_order_id": { "type": "string", "description": "Fulfillment order ID" }, "data": { "$ref": "#/components/schemas/APIUpdateCreditChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdateReturnInspectionChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "return_id": { "type": "string", "description": "Return ID" } }, "required": ["name", "quantity", "return_id"], "type": "object", "additionalProperties": false }, "APIUpdateReturnInspectionChargeInput": { "properties": { "data": { "$ref": "#/components/schemas/APIUpdateReturnInspectionChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIUpdateReceivingChargeData": { "properties": { "name": { "type": "string", "description": "Charge name" }, "description": { "type": ["string", "null"], "description": "Charge description" }, "quantity": { "type": "number", "format": "double", "description": "Quantity" }, "purchase_order_id": { "type": "string", "description": "Purchase order ID" } }, "required": ["name", "quantity", "purchase_order_id"], "type": "object", "additionalProperties": false }, "APIUpdateReceivingChargeInput": { "properties": { "data": { "$ref": "#/components/schemas/APIUpdateReceivingChargeData", "description": "Charge data" } }, "required": ["data"], "type": "object", "additionalProperties": false }, "APIBaseDisabledCarrier": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update timestamp" }, "team_id": { "type": "string", "description": "Team ID" }, "carrier_id": { "type": "string", "description": "Carrier ID" }, "carrier_integration_id": { "type": "string", "description": "Carrier Integration ID" } }, "required": ["id", "created_at", "updated_at", "team_id", "carrier_id", "carrier_integration_id"], "type": "object", "additionalProperties": false }, "APIBaseDisabledServiceLevel": { "properties": { "id": { "type": "string", "description": "Unique identifier" }, "created_at": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update timestamp" }, "team_id": { "type": "string", "description": "Team ID" }, "carrier_integration_id": { "type": "string", "description": "Carrier Integration ID" }, "service_id": { "type": "string", "description": "Service ID" }, "carrier_id": { "type": "string", "description": "Carrier ID" } }, "required": ["id", "created_at", "updated_at", "team_id", "carrier_integration_id", "service_id", "carrier_id"], "type": "object", "additionalProperties": false }, "APIExpandedCarrierIntegrationWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "id": { "type": "string", "description": "Unique identifier" }, "name": { "type": "string", "description": "Name" }, "type": { "$ref": "#/components/schemas/APICarrierType", "description": "Type of carrier integration" }, "team_id": { "type": "string", "description": "Team ID" }, "active": { "type": "boolean", "description": "Whether the integration is active" }, "created_at": { "type": "string", "format": "date-time", "description": "When the integration was created" }, "expires_at": { "type": ["string", "null"], "format": "date-time", "description": "When the integration expires" }, "team_name": { "type": "string", "description": "Name of the team" }, "disabled_carriers": { "items": { "$ref": "#/components/schemas/APIBaseDisabledCarrier" }, "type": "array" }, "disabled_service_levels": { "items": { "$ref": "#/components/schemas/APIBaseDisabledServiceLevel" }, "type": "array" } }, "required": [ "id", "name", "type", "team_id", "active", "created_at", "expires_at", "team_name", "disabled_carriers", "disabled_service_levels" ], "type": "object", "additionalProperties": false }, "APIMinimalCarrierIntegrationWithActions": { "description": "API Carrier Integration with minimal data and supported actions for public API", "properties": { "id": { "type": "string", "description": "Unique identifier" }, "name": { "type": "string", "description": "Name" }, "type": { "$ref": "#/components/schemas/APICarrierType", "description": "Type of carrier integration" }, "team_id": { "type": "string", "description": "Team ID" }, "active": { "type": "boolean", "description": "Whether the integration is active" }, "created_at": { "type": "string", "format": "date-time", "description": "When the integration was created" }, "expires_at": { "type": ["string", "null"], "format": "date-time", "description": "When the integration expires" }, "team_name": { "type": "string", "description": "Name of the team" } }, "required": ["id", "name", "type", "team_id", "active", "created_at", "expires_at", "team_name"], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIMinimalCarrierIntegrationWithActions_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalCarrierIntegrationWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIGetManyCarrierIntegrationsResponse": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalCarrierIntegrationWithActions_", "description": "Response type for get-many operations (optimized for lists)" }, "MerchantProduct": { "properties": { "length": { "type": "number", "format": "double" }, "type": { "$ref": "#/components/schemas/APIProductType" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "weight": { "type": ["number", "null"], "format": "double" }, "id": { "type": "string" }, "first_article_inspection_completed_at": { "type": ["string", "null"], "format": "date-time" }, "image_url": { "type": ["string", "null"] }, "name": { "type": "string" }, "sku": { "type": ["string", "null"] }, "cost_price": { "type": ["number", "null"], "format": "double" }, "cost_currency": { "type": "string" }, "description": { "type": ["string", "null"] }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit" }, "customs_description": { "type": ["string", "null"] }, "customs_value": { "type": ["number", "null"], "format": "double" }, "customs_value_currency": { "type": "string" }, "config": { "oneOf": [ { "$ref": "#/components/schemas/APIProductConfig" }, { "type": "null" } ] }, "country_of_origin": { "type": ["string", "null"] }, "hs_code": { "type": ["string", "null"] }, "team_id": { "type": "string" } }, "required": [ "length", "type", "width", "height", "weight", "id", "first_article_inspection_completed_at", "image_url", "name", "sku", "cost_price", "cost_currency", "description", "measurement_unit", "weight_unit", "customs_description", "customs_value", "customs_value_currency", "config", "country_of_origin", "hs_code", "team_id" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_MerchantProduct_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/MerchantProduct" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "MerchantProductBundleComponent": { "description": "Product bundle component", "properties": { "component_product_id": { "type": "string" }, "component_quantity": { "type": "number", "format": "double" } }, "required": ["component_product_id", "component_quantity"], "type": "object", "additionalProperties": false }, "MerchantProductAssemblyComponent": { "description": "Product assembly component", "properties": { "component_product_id": { "type": "string" }, "component_quantity": { "type": "number", "format": "double" } }, "required": ["component_product_id", "component_quantity"], "type": "object", "additionalProperties": false }, "MerchantCreateProductInput": { "description": "Subset of the Product resource that is used for creating a new product", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/APIProductType" }, "description": { "type": ["string", "null"] }, "sku": { "type": ["string", "null"] }, "cost_price": { "type": ["number", "null"], "format": "double" }, "weight": { "type": ["number", "null"], "format": "double" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "image_url": { "type": "string" }, "hs_code": { "type": ["string", "null"] }, "country_of_origin": { "type": ["string", "null"] }, "customs_description": { "type": ["string", "null"] }, "customs_value": { "type": ["number", "null"], "format": "double" }, "bundle_components": { "items": { "$ref": "#/components/schemas/MerchantProductBundleComponent" }, "type": "array" }, "assembly_components": { "items": { "$ref": "#/components/schemas/MerchantProductAssemblyComponent" }, "type": "array" } }, "required": ["name", "type"], "type": "object", "additionalProperties": false }, "MerchantUpdateProductInput": { "description": "For updating a product - all fields are optional for partial updates", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/APIProductType" }, "description": { "type": ["string", "null"] }, "sku": { "type": ["string", "null"] }, "cost_price": { "type": ["number", "null"], "format": "double" }, "weight": { "type": ["number", "null"], "format": "double" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "image_url": { "type": "string" }, "hs_code": { "type": ["string", "null"] }, "country_of_origin": { "type": ["string", "null"] }, "customs_description": { "type": ["string", "null"] }, "customs_value": { "type": ["number", "null"], "format": "double" }, "bundle_components": { "items": { "$ref": "#/components/schemas/MerchantProductBundleComponent" }, "type": "array" }, "assembly_components": { "items": { "$ref": "#/components/schemas/MerchantProductAssemblyComponent" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "VendorSupportedActionType": { "enum": ["VIEW_VENDOR", "UPDATE_VENDOR", "ADD_PRODUCTS_TO_VENDOR", "DELETE_VENDOR"], "type": "string" }, "APISupportedAction_VendorSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/VendorSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "VendorSupportedAction": { "$ref": "#/components/schemas/APISupportedAction_VendorSupportedActionType_" }, "APIVendorProduct": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": ["string", "null"] }, "image_url": { "type": ["string", "null"] } }, "required": ["id", "name", "sku", "image_url"], "type": "object", "additionalProperties": false }, "APIVendorWithActions": { "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "merchant_team_id": { "type": "string" }, "merchant_team_name": { "type": "string" }, "fulfiller_team_id": { "type": "string" }, "fulfiller_team_name": { "type": "string" }, "products": { "items": { "$ref": "#/components/schemas/APIVendorProduct" }, "type": "array" }, "supported_actions": { "items": { "$ref": "#/components/schemas/VendorSupportedAction" }, "type": "array" } }, "required": [ "id", "created_at", "updated_at", "vendor_name", "company_name", "address", "address_2", "city", "state", "zip_code", "country", "contact_person_name", "contact_email", "contact_phone", "internal_notes", "merchant_team_id", "merchant_team_name", "fulfiller_team_id", "fulfiller_team_name", "products", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIVendorList": { "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "merchant_team_id": { "type": "string" }, "merchant_team_name": { "type": "string" }, "fulfiller_team_id": { "type": "string" }, "fulfiller_team_name": { "type": "string" } }, "required": [ "id", "created_at", "updated_at", "vendor_name", "company_name", "address", "address_2", "city", "state", "zip_code", "country", "contact_person_name", "contact_email", "contact_phone", "internal_notes", "merchant_team_id", "merchant_team_name", "fulfiller_team_id", "fulfiller_team_name" ], "type": "object", "additionalProperties": false }, "PaginatedResponse_APIVendorList_": { "description": "Standard paginated response with meta object", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIVendorList" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false }, "APIVendor": { "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "merchant_team_id": { "type": "string" }, "merchant_team_name": { "type": "string" }, "fulfiller_team_id": { "type": "string" }, "fulfiller_team_name": { "type": "string" }, "products": { "items": { "$ref": "#/components/schemas/APIVendorProduct" }, "type": "array" } }, "required": [ "id", "created_at", "updated_at", "vendor_name", "company_name", "address", "address_2", "city", "state", "zip_code", "country", "contact_person_name", "contact_email", "contact_phone", "internal_notes", "merchant_team_id", "merchant_team_name", "fulfiller_team_id", "fulfiller_team_name", "products" ], "type": "object", "additionalProperties": false }, "ShipOSCreateVendorInput": { "properties": { "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "product_ids": { "items": { "type": "string" }, "type": "array" }, "merchant_team_id": { "type": ["string", "null"] } }, "required": ["vendor_name", "company_name", "address", "city", "state", "zip_code", "country"], "type": "object", "additionalProperties": false }, "ShipOSUpdateVendorInput": { "properties": { "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "product_ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "MerchantCreateVendorInput": { "properties": { "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "product_ids": { "items": { "type": "string" }, "type": "array" } }, "required": ["vendor_name", "company_name", "address", "city", "state", "zip_code", "country"], "type": "object", "additionalProperties": false }, "MerchantUpdateVendorInput": { "properties": { "vendor_name": { "type": "string" }, "company_name": { "type": "string" }, "address": { "type": "string" }, "address_2": { "type": ["string", "null"] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" }, "country": { "type": "string" }, "contact_person_name": { "type": ["string", "null"] }, "contact_email": { "type": ["string", "null"] }, "contact_phone": { "type": ["string", "null"] }, "internal_notes": { "type": ["string", "null"] }, "product_ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "CartonSupportedActionType": { "enum": ["UPDATE_CARTON", "DELETE_CARTON", "PRINT_BARCODES", "MAKE_DEFAULT"], "type": "string" }, "APISupportedAction_CartonSupportedActionType_": { "properties": { "action": { "$ref": "#/components/schemas/CartonSupportedActionType", "description": "The action value" } }, "required": ["action"], "type": "object", "description": "Represents a supported action that can be performed" }, "APIExpandedCartonWithActions": { "description": "API type for get/get-many operations (with supported actions)", "properties": { "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the carton was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the carton was created" }, "team_id": { "type": "string", "description": "ID of team that owns this carton" }, "default": { "type": "boolean", "description": "Whether this is the default carton" }, "weight": { "type": "number", "format": "double", "description": "Package weight" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "height": { "type": "number", "format": "double", "description": "Package height" }, "width": { "type": "number", "format": "double", "description": "Package width" }, "length": { "type": "number", "format": "double", "description": "Package length" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit for dimensions" }, "name": { "type": "string", "description": "Carton name" }, "id": { "type": "string", "description": "Unique identifier for the carton" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_CartonSupportedActionType_" }, "type": "array" } }, "required": [ "updated_at", "created_at", "team_id", "default", "weight", "weight_unit", "height", "width", "length", "measurement_unit", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIExpandedCarton": { "description": "API type for webhooks/CUD operations (without supported actions)", "properties": { "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the carton was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the carton was created" }, "team_id": { "type": "string", "description": "ID of team that owns this carton" }, "default": { "type": "boolean", "description": "Whether this is the default carton" }, "weight": { "type": "number", "format": "double", "description": "Package weight" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "height": { "type": "number", "format": "double", "description": "Package height" }, "width": { "type": "number", "format": "double", "description": "Package width" }, "length": { "type": "number", "format": "double", "description": "Package length" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit for dimensions" }, "name": { "type": "string", "description": "Carton name" }, "id": { "type": "string", "description": "Unique identifier for the carton" } }, "required": [ "updated_at", "created_at", "team_id", "default", "weight", "weight_unit", "height", "width", "length", "measurement_unit", "name", "id" ], "type": "object", "additionalProperties": false }, "APICreateCartonInput": { "description": "Input for creating a new carton", "properties": { "name": { "type": "string", "description": "Name of the carton" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit for dimensions" }, "length": { "type": "number", "format": "double", "description": "Package length" }, "width": { "type": "number", "format": "double", "description": "Package width" }, "height": { "type": "number", "format": "double", "description": "Package height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Package weight" }, "default": { "type": "boolean", "description": "Whether this is the default carton" } }, "required": ["name", "length", "width", "height", "weight"], "type": "object", "additionalProperties": false }, "APIUpdateCartonInput": { "description": "Input for updating a carton - all fields are optional for partial updates", "properties": { "name": { "type": "string", "description": "Name of the carton" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit for dimensions" }, "length": { "type": "number", "format": "double", "description": "Package length" }, "width": { "type": "number", "format": "double", "description": "Package width" }, "height": { "type": "number", "format": "double", "description": "Package height" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "weight": { "type": "number", "format": "double", "description": "Package weight" }, "default": { "type": "boolean", "description": "Whether this is the default carton" } }, "type": "object", "additionalProperties": false }, "APIMinimalCartonWithActions": { "description": "API Carton with minimal data and supported actions for public API", "properties": { "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "When the carton was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "When the carton was created" }, "team_id": { "type": "string", "description": "ID of team that owns this carton" }, "default": { "type": "boolean", "description": "Whether this is the default carton" }, "weight": { "type": "number", "format": "double", "description": "Package weight" }, "weight_unit": { "$ref": "#/components/schemas/APIWeightUnit", "description": "Weight unit" }, "height": { "type": "number", "format": "double", "description": "Package height" }, "width": { "type": "number", "format": "double", "description": "Package width" }, "length": { "type": "number", "format": "double", "description": "Package length" }, "measurement_unit": { "$ref": "#/components/schemas/APIMeasurementUnit", "description": "Measurement unit for dimensions" }, "name": { "type": "string", "description": "Carton name" }, "id": { "type": "string", "description": "Unique identifier for the carton" }, "supported_actions": { "items": { "$ref": "#/components/schemas/APISupportedAction_CartonSupportedActionType_" }, "type": "array", "description": "Supported actions for this carton" } }, "required": [ "updated_at", "created_at", "team_id", "default", "weight", "weight_unit", "height", "width", "length", "measurement_unit", "name", "id", "supported_actions" ], "type": "object", "additionalProperties": false }, "APIGetManyCartonsResponse": { "description": "Response for getting multiple cartons with minimal data", "properties": { "data": { "items": { "$ref": "#/components/schemas/APIMinimalCartonWithActions" }, "type": "array", "description": "Array of items for the current page" }, "meta": { "$ref": "#/components/schemas/PaginationMeta", "description": "Pagination metadata" } }, "required": ["data", "meta"], "type": "object", "additionalProperties": false } }, "securitySchemes": { "api_key": { "type": "apiKey", "name": "x-access-token", "in": "header" } } }, "info": { "title": "Cybership API", "version": "0.0.0", "description": "Our REST API exposes publicly most of our internal functionality to our customers", "contact": { "email": "jack@cybership.io", "name": "Jack Kelly", "url": "https://cybership.io/contact" } }, "paths": { "/token": { "get": { "operationId": "GetToken", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIBaseAPIKey" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Can be used to check whether authentication is working,\nand to inspect the API key used to authenticate.", "security": [ { "api_key": [] } ], "parameters": [] } }, "/shipos/work-orders/{work_order_id}": { "get": { "operationId": "GetWorkOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedWorkOrderWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a single work order by ID", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the work order to retrieve", "in": "path", "name": "work_order_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateWorkOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedWorkOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:conflict" }, "title": { "type": "string", "example": "Conflict" }, "status": { "type": "integer", "example": 409 }, "detail": { "type": "string", "example": "An order with this reference already exists (Reference this ID for support: trace-789016ghijklmn3)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update an existing work order with partial data\n\n## Array Field Update Behavior\n**Important**: Including ANY array field replaces ALL existing items:\n\n- Include appropriate `id` field to **update** existing items\n- Omit `id` field to **create** new items\n- Items **NOT** included in the array will be **DELETED**\n\n**Applies to**: `work_order_line_items`, `pickers`, `packers`\n\n## Status-Based Restrictions\n**Started work orders** (`IN_PROGRESS` or `COMPLETED` status) have additional restrictions:\n- **Cannot update**: `staging_location_id`, `quantity_to_assemble`\n- **Components**: Cannot update `product_stock_id` values\n\n## Status Transitions\nWork orders enforce strict status transition rules:\n\n| Current Status | Can Transition To | Notes |\n|---------------|------------------|-------|\n| `AWAITING_APPROVAL` | `APPROVED`, `CANCELLED` | Initial state after creation |\n| `APPROVED` | `IN_PROGRESS`, `CANCELLED`, `AWAITING_APPROVAL` | Ready to start |\n| `IN_PROGRESS` | `COMPLETED`, `CANCELLED` | Work is actively being performed |\n| `COMPLETED` | `AWAITING_APPROVAL` | Rollback allowed for corrections |\n| `CANCELLED` | *(none)* | Final state - no further transitions |", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the work order to update", "in": "path", "name": "work_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSUpdateWorkOrderInput" } } } } }, "delete": { "operationId": "DeleteWorkOrder", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "required": ["success"], "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a work order by ID", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the work order to delete", "in": "path", "name": "work_order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/work-orders/{work_order_id}/packages": { "get": { "operationId": "GetWorkOrderPackages", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIWorkOrderPackagesOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get the physical packages attached to a work order.\n\nLabel fields are returned on each package, including `shipping_label_id`,\n`shipping_label_tracking_code`, `shipping_label_formatted_service`,\n`shipment_status`, and `shipping_label_url`.", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The work order whose packages should be returned", "in": "path", "name": "work_order_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateWorkOrderPackages", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIWorkOrderPackingUpdateResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Replace the complete package set for a work order.\n\nExisting package IDs are updated, entries without IDs are created, and\nexisting packages omitted from the request are deleted. Authoritative\npacking clients should include the protocol, revision, base package keys,\nand unpacked items so concurrent edits are rejected instead of overwritten.\n\nAfter updating, retrieve rates from `GET /shipos/packages/{package_id}/rates`\nand purchase each label with `POST /shipos/packages/{package_id}/buy-label`.\nPass the caller's printable PO value as `print_custom_1` on label purchase;\nit is forwarded only to the label's first printable custom-reference field.\nManual labels can be attached through\n`POST /shipos/packages/{package_id}/upload-label`.", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "work_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateWorkOrderPackagesInput" } } } } } }, "/shipos/work-orders": { "get": { "operationId": "GetManyWorkOrders", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyWorkOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple work orders with filtering, searching, and pagination", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter work orders by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "scheduled_by", "requested_by", "completed_at", "updated_at", "priority"] } }, { "description": "Sort order - \"asc\" or \"desc\"", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "description": "Filter by work order type (ASSEMBLY, CUSTOM)", "in": "query", "name": "type", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by work order status", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by priority", "in": "query", "name": "priority", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by merchant team ID", "in": "query", "name": "merchant_team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse ID", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by scheduled date (start)", "in": "query", "name": "scheduled_by_start", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by scheduled date (end)", "in": "query", "name": "scheduled_by_end", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by completion date (start)", "in": "query", "name": "completed_at_start", "required": false, "schema": { "default": "", "type": "string" } } ] }, "post": { "operationId": "CreateWorkOrder", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedWorkOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new work order with line items.", "tags": ["ShipOS Work Orders"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSCreateWorkOrderInput" } } } } } }, "/shipos/warehouses/{warehouse_id}": { "get": { "operationId": "GetWarehouse", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedWarehouseWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a warehouse by its ID", "tags": ["ShipOS Warehouses"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the warehouse to find", "in": "path", "name": "warehouse_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateWarehouse", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedWarehouse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a warehouse by ID", "tags": ["ShipOS Warehouses"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the warehouse to be updated", "in": "path", "name": "warehouse_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the warehouse", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateWarehouseInput", "description": "The new values for the warehouse" } } } } }, "delete": { "operationId": "DeleteWarehouse", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a warehouse by ID\n\n**Note:** Warehouses can only be deleted if they:\n- Have no active locations\n- Have no pending fulfillments\n- Have no active operations", "tags": ["ShipOS Warehouses"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the warehouse to delete", "in": "path", "name": "warehouse_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/warehouses": { "post": { "operationId": "CreateWarehouse", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedWarehouse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new warehouse", "tags": ["ShipOS Warehouses"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a warehouse", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateWarehouseInput", "description": "The fields needed to create a warehouse" } } } } }, "get": { "operationId": "GetManyWarehouses", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyWarehousesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple warehouses with pagination and filtering", "tags": ["ShipOS Warehouses"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter warehouses by name, company, or city", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Include warehouses from teams this team delegates fulfillment to", "in": "query", "name": "include_fulfiller_warehouses", "required": false, "schema": { "default": false, "type": "boolean" } } ] } }, "/shipos/totes/{tote_id}": { "get": { "operationId": "GetTote", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMinimalTote" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a tote by its ID", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the tote to find", "in": "path", "name": "tote_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateTote", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMinimalTote" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a tote by ID", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the tote to be updated", "in": "path", "name": "tote_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the tote", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateToteInput", "description": "The new values for the tote" } } } } }, "delete": { "operationId": "DeleteTote", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a tote by ID", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the tote to delete", "in": "path", "name": "tote_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/totes": { "post": { "operationId": "CreateTote", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMinimalTote" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new tote", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a tote", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateToteInput", "description": "The fields needed to create a tote" } } } } }, "get": { "operationId": "GetManyTotes", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyTotesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple totes with pagination and filtering", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter totes by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by barcode", "in": "query", "name": "barcode", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter totes by whether they have orders", "in": "query", "name": "has_orders", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter for empty totes", "in": "query", "name": "empty", "required": false, "schema": { "type": "boolean" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/totes/{tote_id}/move": { "post": { "operationId": "MoveTote", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMinimalTote" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Move a tote to a new parent location\n\nThis endpoint allows moving a tote to a new parent location.\nTotes can only be moved to hospital locations or to root (no parent).", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the tote to move", "in": "path", "name": "tote_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new parent location", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveToteInput", "description": "The new parent location" } } } } } }, "/shipos/totes/{tote_id}/empty": { "post": { "operationId": "EmptyTote", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Empty a tote\n\nThis endpoint removes all stock from a tote.\nOnly works on locations with location_kind = TOTE.", "tags": ["ShipOS Totes"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the tote to empty", "in": "path", "name": "tote_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/shops/{shop_id}": { "get": { "operationId": "GetShop", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedShopWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a shop by its ID", "tags": ["ShipOS Shops"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the shop to find", "in": "path", "name": "shop_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/shops": { "get": { "operationId": "GetManyShops", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyShopsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple shops with pagination and filtering", "tags": ["ShipOS Shops"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter shops by name or domain", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop type (comma-separated for multiple values)", "in": "query", "name": "type", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop domain (comma-separated for multiple values)", "in": "query", "name": "domain", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by merchant team ID (comma-separated for multiple values)", "in": "query", "name": "merchant_team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/shipping-labels": { "get": { "operationId": "GetManyShippingLabels", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyShippingLabelsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple shipping labels with pagination and filtering", "tags": ["ShipOS Shipping Labels"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter labels by tracking code, remote ID, or carrier ID", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "voided_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "description": "Filter by scan status *(comma-separated for multiple)*", "in": "query", "name": "scan_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shipment status *(comma-separated for multiple)*", "in": "query", "name": "shipment_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by refund status *(comma-separated for multiple)*", "in": "query", "name": "refund_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by carrier ID *(comma-separated for multiple)*", "in": "query", "name": "carrier_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by service ID *(comma-separated for multiple)*", "in": "query", "name": "service_id", "required": false, "schema": { "default": "", "type": "string" } } ] } }, "/shipos/shipping-labels/{id}": { "get": { "operationId": "GetShippingLabel", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedShippingLabel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a single shipping label by ID", "tags": ["ShipOS Shipping Labels"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The shipping label ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/shipping-labels/{id}/commercial-invoice": { "post": { "operationId": "GenerateCommercialInvoice", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCommercialInvoiceResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Generate a commercial invoice PDF for a shipping label", "tags": ["ShipOS Shipping Labels"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The shipping label ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/shipping-labels/{id}/void": { "post": { "operationId": "VoidShippingLabel", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "required": ["description", "title"], "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:service-unavailable" }, "title": { "type": "string", "example": "Service Unavailable" }, "status": { "type": "integer", "example": 503 }, "detail": { "type": "string", "example": "The service is temporarily unavailable. Please try again later." } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Void a shipping label\n\nVoids a shipping label and refunds the cost. This action cannot be undone.\nThe label will be marked as voided and any packages associated with it will be\nunlinked so they can have new labels purchased.", "tags": ["ShipOS Shipping Labels"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The shipping label ID to void", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/shipment-mappings/{shipment_mapping_id}": { "get": { "operationId": "GetShipmentMapping", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedShipmentMappingWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a shipment mapping by its ID", "tags": ["ShipOS Shipment Mappings"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the shipment mapping to find", "in": "path", "name": "shipment_mapping_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateShipmentMapping", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedShipmentMapping" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a shipment mapping by ID", "tags": ["ShipOS Shipment Mappings"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the shipment mapping to be updated", "in": "path", "name": "shipment_mapping_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the shipment mapping", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateShipmentMappingInput", "description": "The new values for the shipment mapping" } } } } }, "delete": { "operationId": "DeleteShipmentMapping", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a shipment mapping by ID", "tags": ["ShipOS Shipment Mappings"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the shipment mapping to delete", "in": "path", "name": "shipment_mapping_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/shipment-mappings": { "post": { "operationId": "CreateShipmentMapping", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedShipmentMapping" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new shipment mapping", "tags": ["ShipOS Shipment Mappings"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a shipment mapping", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateShipmentMappingInput", "description": "The fields needed to create a shipment mapping" } } } } }, "get": { "operationId": "GetManyShipmentMappings", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyShipmentMappingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple shipment mappings with pagination and filtering", "tags": ["ShipOS Shipment Mappings"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter shipment mappings by shipping method", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by must ship option *(comma-separated for multiple)*", "in": "query", "name": "must_ship", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop IDs *(comma-separated for multiple)*", "in": "query", "name": "shop_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter for wildcard mappings", "in": "query", "name": "wildcard", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter for mappings that enforce cutoff time", "in": "query", "name": "enforce_cutoff", "required": false, "schema": { "type": "boolean" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/rate-cards/{rate_card_id}": { "get": { "operationId": "GetRateCard", "responses": { "200": { "description": "Rate card retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedRateCardWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Rate Cards"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "rate_card_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateRateCard", "responses": { "200": { "description": "Rate card updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedRateCard" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Rate Cards"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "rate_card_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateRateCardInput" } } } } }, "delete": { "operationId": "DeleteRateCard", "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a rate card by ID\n\n**Note:** Rate cards can only be deleted if they are not referenced by any fulfillment delegations.", "tags": ["ShipOS Rate Cards"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the rate card to delete", "in": "path", "name": "rate_card_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/rate-cards": { "post": { "operationId": "CreateRateCard", "responses": { "201": { "description": "Rate card created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedRateCard" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Rate Cards"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateRateCardInput" } } } } }, "get": { "operationId": "GetManyRateCards", "responses": { "200": { "description": "Rate cards retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyRateCardsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Rate Cards"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "format": "double", "type": "number" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "name", "updated_at"] } }, { "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } } ] } }, "/shipos/rate-cards/{rate_card_id}/duplicate": { "post": { "operationId": "DuplicateRateCard", "responses": { "201": { "description": "Rate card duplicated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedRateCard" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Rate Cards"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "rate_card_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "new_name": { "type": "string" } }, "required": ["new_name"], "type": "object" } } } } } }, "/shipos/purchase-orders/{purchase_order_id}": { "get": { "operationId": "GetPurchaseOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedPurchaseOrderWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a single purchase order by ID", "tags": ["ShipOS Purchase Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the purchase order to retrieve", "in": "path", "name": "purchase_order_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdatePurchaseOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update an existing purchase order with partial data", "tags": ["ShipOS Purchase Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the purchase order to update", "in": "path", "name": "purchase_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSAPIUpdatePurchaseOrderInput" } } } } }, "delete": { "operationId": "DeletePurchaseOrder", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "required": ["success"], "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a purchase order by ID", "tags": ["ShipOS Purchase Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the purchase order to delete", "in": "path", "name": "purchase_order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/purchase-orders": { "get": { "operationId": "GetManyPurchaseOrders", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyPurchaseOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple purchase orders with filtering, searching, and pagination", "tags": ["ShipOS Purchase Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter purchase orders by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["expected_at", "updated_at", "created_at"] } }, { "description": "Sort order - \"asc\" or \"desc\"", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] }, "post": { "operationId": "CreatePurchaseOrder", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new purchase order with line items and lots.", "tags": ["ShipOS Purchase Orders"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSAPICreatePurchaseOrderInput" } } } } } }, "/shipos/products/{product_id}": { "get": { "operationId": "GetProduct", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedProductWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a product by its ID", "tags": ["ShipOS Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the product to find", "in": "path", "name": "product_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateProduct", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedProduct" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a product by ID\n\n**Important behavior for array fields (bundle_components, assembly_components):**\n- If omitted: Existing components are preserved\n- If empty array `[]`: All components are removed\n- If array with items: All existing components are replaced", "tags": ["ShipOS Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the product to be updated", "in": "path", "name": "product_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the product", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicUpdateProductInput", "description": "The new values for the product" } } } } }, "delete": { "operationId": "DeleteProduct", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a product by ID", "tags": ["ShipOS Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the product to delete", "in": "path", "name": "product_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/products": { "post": { "operationId": "CreateProduct", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedProduct" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new product\n\n**Measurement and Weight Units:**\n- `weight_unit` and `measurement_unit` are optional\n- If omitted, defaults to the owning team's measurement system units\n- Explicit values override team defaults", "tags": ["ShipOS Products"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a product", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicCreateProductInput", "description": "The fields needed to create a product" } } } } }, "get": { "operationId": "GetManyProducts", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicGetManyProductsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple products with pagination and filtering", "tags": ["ShipOS Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter products by name, SKU, or product barcode", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "description": "Filter by product types *(comma-separated for multiple)*", "in": "query", "name": "type", "required": false, "schema": { "default": "", "type": "string" } }, { "in": "query", "name": "team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter products that have/don't have images", "in": "query", "name": "has_image", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter products that have/don't have product barcodes", "in": "query", "name": "has_barcode", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter products that have/don't have remote products", "in": "query", "name": "has_remote_products", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter products that were/weren't inspected", "in": "query", "name": "was_inspected", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter inventory results by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } } ] } }, "/shipos/product-stock/{product_stock_id}": { "get": { "operationId": "GetProductStock", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedProductStockWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a product stock record by its ID", "tags": ["ShipOS Product Stock"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the product stock record", "in": "path", "name": "product_stock_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateProductStock", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedProductStock" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a product stock record\n\nThis endpoint supports partial updates - only include fields you want to change.\nYou can update quantity, lot code, expiration date, or move stock to a different location.\nProduct reassignment is not supported. Delete the stock record and create a new one instead.", "tags": ["ShipOS Product Stock"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the product stock to update", "in": "path", "name": "product_stock_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The fields to update", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSUpdateProductStockInput", "description": "The fields to update" } } } } }, "delete": { "operationId": "DeleteProductStock", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a product stock record", "tags": ["ShipOS Product Stock"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the product stock to delete", "in": "path", "name": "product_stock_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/product-stock": { "post": { "operationId": "CreateProductStock", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedProductStock" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new product stock record\n\nThis endpoint creates a new stock record for a product at a specific location.\nNote that you cannot create stock for VIRTUAL_BUNDLE products.", "tags": ["ShipOS Product Stock"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create product stock", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSCreateProductStockInput", "description": "The fields needed to create product stock" } } } } }, "get": { "operationId": "GetManyProductStocks", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyProductStocksResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple product stock records with filtering and pagination", "tags": ["ShipOS Product Stock"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter by product name, SKU, location name, or lot code", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "on_hand", "expiration_date"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "description": "Filter by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by product IDs *(comma-separated for multiple)*", "in": "query", "name": "product_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by location IDs *(comma-separated for multiple)*", "in": "query", "name": "location_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by product types *(comma-separated for multiple)*", "in": "query", "name": "product_type", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter for items with on_hand greater than or equal to this value", "in": "query", "name": "on_hand_min", "required": false, "schema": { "default": null, "format": "double", "type": "number" } }, { "description": "Filter for items with on_hand less than or equal to this value", "in": "query", "name": "on_hand_max", "required": false, "schema": { "default": null, "format": "double", "type": "number" } } ] } }, "/shipos/product-stock/{product_stock_id}/transfer": { "post": { "operationId": "TransferProductStock", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedProductStock" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Transfer product stock to another location\n\nThis endpoint transfers a specified quantity from one location to another.\nIf the destination already has stock of the same product with matching lot code and expiration date,\nthe quantities will be combined. Otherwise, a new stock record will be created.", "tags": ["ShipOS Product Stock"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the source product stock", "in": "path", "name": "product_stock_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Transfer details including destination and quantity", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSTransferProductStockInput", "description": "Transfer details including destination and quantity" } } } } } }, "/shipos/product-listings/{product_listing_id}": { "get": { "operationId": "GetProductListing", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedProductListingWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a product listing by its ID", "tags": ["ShipOS Product Listings"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the product listing to find", "in": "path", "name": "product_listing_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/product-listings": { "get": { "operationId": "GetManyProductListings", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyProductListingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple product listings with pagination and filtering", "tags": ["ShipOS Product Listings"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter product listings by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by product listing name", "in": "query", "name": "name", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by product listing status", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop ID", "in": "query", "name": "shop_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop type", "in": "query", "name": "shop_type", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter for listings with variants", "in": "query", "name": "has_variants", "required": false, "schema": { "type": "boolean" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "name"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/product-listing-variants/{product_listing_variant_id}": { "get": { "operationId": "GetProductListingVariant", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedProductListingVariantWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a product listing variant by its ID", "tags": ["ShipOS Product Listing Variants"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the product listing variant to find", "in": "path", "name": "product_listing_variant_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/product-listing-variants": { "get": { "operationId": "GetManyProductListingVariants", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyProductListingVariantsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple product listing variants with pagination and filtering", "tags": ["ShipOS Product Listing Variants"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter variants by title or SKU", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by product listing ID", "in": "query", "name": "product_listing_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop ID", "in": "query", "name": "shop_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by linked product ID", "in": "query", "name": "product_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter for variants with linked products (true for linked, false for unlinked)", "in": "query", "name": "has_product", "required": false, "schema": { "type": "boolean" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/v1/picking-sessions/single-order": { "post": { "operationId": "CreatePickingSessionForOneOrder", "responses": { "201": { "description": "Picking session created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPickingSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create Picking Session for One Order\n\nCreates a picking session for a single fulfillment order.\nThis is the simplest session type for picking individual orders.", "summary": "Create for one order", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateSingleOrderInput" } } } } } }, "/shipos/v1/picking-sessions/multi-item": { "post": { "operationId": "CreatePickingSession", "responses": { "201": { "description": "Picking session created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPickingSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create Picking Session\n\nAutomatically finds and batches multiple eligible orders for batch picking.\nThe system applies the configured picking-session order strategy and batch-optimization settings.", "summary": "Create picking session", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateMultiItemBatchInput" } } } } } }, "/shipos/v1/picking-sessions/from-orders": { "post": { "operationId": "CreatePickingSessionFromOrders", "responses": { "201": { "description": "Picking session created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIByFulfillmentOrderIdsPickingSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create Picking Session from Orders\n\nCreates a picking session for specific fulfillment order IDs with detailed allocation tracking.\nUses a partial success strategy - creates session if at least one order can be allocated.\nReturns HTTP 400 if no orders can be allocated (no session is created).\n\nReturns detailed information about which orders were successfully added and which failed,\nincluding specific failure reasons and actionable suggestions for each failed order.", "summary": "Create from orders", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateByFulfillmentOrderIdsInput" } } } } } }, "/shipos/v1/picking-sessions/{picking_session_id}": { "get": { "operationId": "GetPickingSession", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedPickingSession" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get Picking Session\n\nRetrieves details of a specific picking session including all orders, line items, and allocations.", "summary": "Get picking session", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the picking session to retrieve", "in": "path", "name": "picking_session_id", "required": true, "schema": { "type": "string" } } ] }, "delete": { "operationId": "CancelPickingSession", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Cancel Picking Session\n\nCancels a picking session. Can only cancel sessions that are not yet closed.\nReleases all fulfillment order locks associated with the session.", "summary": "Cancel picking session", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the picking session to cancel", "in": "path", "name": "picking_session_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/v1/picking-sessions": { "get": { "operationId": "GetManyPickingSessions", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyPickingSessionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get Many Picking Sessions\n\nRetrieves a paginated list of picking sessions with optional filtering and search.", "summary": "Get many picking sessions", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination (starting from 0)", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page (default: 10)", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "format": "double", "type": "number" } }, { "description": "Search term to filter by user name or warehouse name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse IDs (comma-separated for multiple)", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by session type (comma-separated for multiple)", "in": "query", "name": "type", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by session status (comma-separated for multiple)", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction (\"asc\" or \"desc\")", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/v1/picking-sessions/{picking_session_id}/duplicate": { "post": { "operationId": "DuplicatePickingSession", "responses": { "201": { "description": "Picking session duplicated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPickingSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Duplicate Picking Session\n\nCreates a new picking session with the same configuration as an existing one.\nOnly works for MULTI_ITEM_BATCH sessions. The new session will attempt to find\nnew eligible orders with the same parameters (bins, merchant filter, unit constraints).", "summary": "Duplicate picking session", "tags": ["ShipOS Picking Sessions"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the picking session to duplicate", "in": "path", "name": "picking_session_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/v1/picking-sessions/{picking_session_id}/fulfillment-orders": { "get": { "operationId": "GetPickingSessionFulfillmentOrders", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_APIMinimalPickingSessionFulfillmentOrder_" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get Fulfillment Orders\n\nRetrieves all fulfillment orders within a picking session. Returns paginated, detailed information\nabout each order including line items, product details, and allocations.", "summary": "Get fulfillment orders", "tags": ["ShipOS Picking Sessions", "Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the picking session", "in": "path", "name": "picking_session_id", "required": true, "schema": { "type": "string" } }, { "description": "Optional filter by fulfillment order status (PENDING or FULFILLED)", "in": "query", "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/PickingSessionFulfillmentOrderStatus" } }, { "description": "Page number for pagination (0-based, default 0)", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Maximum number of results to return per page (1-50, default 10)", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "format": "double", "type": "number" } }, { "description": "Field to order by (order_number, created_at, or updated_at, default order_number)", "in": "query", "name": "order_by", "required": false, "schema": { "default": "order_number", "type": "string", "enum": ["order_number", "created_at", "updated_at"] } }, { "description": "Sort order (asc or desc, default asc)", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/v1/picking-sessions/{picking_session_id}/fulfillment-orders/{fulfillment_order_id}": { "get": { "operationId": "GetPickingSessionFulfillmentOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedPickingSessionFulfillmentOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get Fulfillment Order\n\nRetrieves a specific fulfillment order within a picking session. Returns detailed information\nincluding line items, product details, allocations, and tote assignment.", "summary": "Get fulfillment order", "tags": ["ShipOS Picking Sessions", "Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the picking session", "in": "path", "name": "picking_session_id", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the fulfillment order", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/packages/{package_id}": { "get": { "operationId": "GetPackage", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedPackageWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a package by its ID", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the package to find", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdatePackage", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedPackage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a package by ID\n\n## Package Type Restrictions\n- Package type is immutable (cannot change `fulfillment_order_id` or package type after creation)\n- Line item validation rules must match the original package type\n\n## Line Item Updates\n**Important**: Including `package_line_items` replaces ALL existing line items:\n- Include `id` field to update existing line items\n- Omit `id` field to create new line items\n- Line items not included in the array will be deleted", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the package to be updated", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the package", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicUpdatePackageInput", "description": "The new values for the package" } } } } }, "delete": { "operationId": "DeletePackage", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a package by ID\n\n## Deletion Restrictions\nPackages can only be deleted if:\n- Package does not have a shipping label\n- Package is not part of a manifest\n- Package is not fulfilled", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the package to delete", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/packages": { "post": { "operationId": "CreatePackage", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedPackage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new package\n\n## Package Types\n\n### `FULFILLMENT_ORDER` Packages\n- **How to create**: Include `fulfillment_order_id`\n- **Line items**: Must have `core_fulfillment_order_line_item_id`\n- **Address fallback**: Automatic (from order & warehouse)\n- **Customs config**: Resolved from package config → fulfillment order config → order config → delegation config → team config → defaults\n\n### `STANDALONE` Packages\n- **How to create**: Omit `fulfillment_order_id`\n- **Line items**: Must have `product_id` and `name`\n- **Address fallback**: None (manual addresses required)\n- **Customs config**: Resolved from package config → team config → defaults\n\n## Package Status\n**All packages are created with `PENDING` status**. Status changes are managed automatically through the system workflow (labeling, fulfillment, etc.). You cannot specify a custom status during creation.\n\n## Automatic Field Fallback\n\n**When address fallback occurs**:\n- **Omitted or `undefined`**: Uses order/warehouse defaults where available\n- **`null`**: No fallback (intentionally cleared)\n- **Explicit value**: No fallback (uses your value)\n\n### Address Fields (`FULFILLMENT_ORDER` only)\n- **`to_address_*`**: Falls back to customer's order shipping address\n- **`from_address_*`**: Falls back to assigned warehouse address\n\n### Customs Config (all package types)\n- Customs policy lives in **`config`**.\n- Resolution priority: package config → fulfillment order config → order config → delegation config → team config → defaults.\n\n**Tip**: Omit a config field or pass `null` to inherit the next layer's value.", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a package", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicCreatePackageInput", "description": "The fields needed to create a package" } } } } }, "get": { "operationId": "GetManyPackages", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicGetManyPackagesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple packages with pagination and filtering", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter packages by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by fulfillment order IDs *(comma-separated for multiple)*", "in": "query", "name": "fulfillment_order_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by package status *(comma-separated for multiple)*", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by carrier integration IDs *(comma-separated for multiple)*", "in": "query", "name": "carrier_integration_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by merchant team IDs *(comma-separated for multiple)*", "in": "query", "name": "merchant_team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by (created_at, updated_at, name)", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "name"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/packages/{package_id}/rates": { "get": { "operationId": "GetRates", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPackageRatesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get shipping rates for a package\n\n## Requirements\n- Package must have valid shipping addresses and dimensions\n- For `FULFILLMENT_ORDER` packages: You must own the fulfillment order lock to access rates\n- For `WORK_ORDER` and `STANDALONE` packages: No lock ownership required\n\n## Response Format\nReturns available rates sorted by price (cheapest first) plus any carrier errors encountered.\nEach rate includes carrier details, service information, pricing, and estimated delivery time.", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the package to get rates for", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/packages/{package_id}/upload-label": { "post": { "operationId": "UploadLabel", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPackageLabelResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Upload a shipping label for a package\n\n## Requirements\n- Package must not already have a shipping label\n- Label file size must not exceed 10MB\n- For `FULFILLMENT_ORDER` packages: You must own the fulfillment order lock (provide `lock_owner`)\n- For `WORK_ORDER` and `STANDALONE` packages: No lock ownership required\n\n## Supported Formats\nUpload shipping labels in these formats:\n- **PDF**: Most common format for shipping labels\n- **PNG**: High-quality image format\n- **JPG/JPEG**: Compressed image format\n\n## File Encoding\nProvide the label file as base64-encoded content in the request body.", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the package to upload label for", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPackageLabelRequest" } } } } } }, "/shipos/packages/{package_id}/buy-label": { "post": { "operationId": "BuyLabel", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedPackage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Buy a shipping label for a package\n\n## Requirements\n- Package must not already have a shipping label\n- Package must have valid shipping addresses and dimensions\n- For `FULFILLMENT_ORDER` packages: You must own the fulfillment order lock (provide `lock_owner`)\n- For `WORK_ORDER` and `STANDALONE` packages: No lock ownership required (`lock_owner` parameter ignored)\n\n## Carrier Selection\nThe system will use carrier information in this priority order:\n1. **Request overrides**: `carrier_integration_id`, `carrier_id`, `service_id` from request body\n2. **Package defaults**: Existing carrier settings on the package\n3. **Rate shop**: Automatic selection based on the package's rate shop profile\n\n`print_custom_1` is optional and request-scoped. It is forwarded only to the\nfirst printable custom-reference field for this label purchase; it is not\nstored on or used to identify the package.\n\n```json\n{\n \"print_custom_1\": \"PO-1042-CARTON-1\",\n \"carrier_integration_id\": \"integration-id\",\n \"carrier_id\": \"usps\",\n \"service_id\": \"priority\"\n}\n```\n\n## Response\nReturns the updated package with the new shipping label attached, including tracking number and label URL.", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the package to buy label for", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request body containing `lock_owner`, optional carrier overrides, and an optional label reference", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyPackageLabelRequest", "description": "Request body containing `lock_owner`, optional carrier overrides, and an optional label reference" } } } } } }, "/shipos/packages/{package_id}/fulfill": { "post": { "operationId": "FulfillPackage", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedPackage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Completely fulfills a package and triggers all associated operations:\n\n### 1. Package Validation & Lock Management\n- **Verifies not already fulfilled** (prevents duplicate fulfillments)\n- **`FULFILLMENT_ORDER`**: Validates `locked_by` owns the fulfillment order lock\n- **`STANDALONE`**: No lock validation required\n\n### 2. External Sales Channel Fulfillment\n- **`FULFILLMENT_ORDER`**: **Creates remote fulfillment** on connected sales channels (Shopify, BigCommerce, WooCommerce)\n- **`STANDALONE`**: **Skips remote fulfillment** (internal-only fulfillment)\n\n### 3. Internal Fulfillment Creation\n- **Creates fulfillment record** with tracking information and shipment details\n- **Links fulfillment to package** for complete audit trail\n- **Sets fulfillment type** (`PICK_PACK`, `MANUAL`, `API`, etc.) based on input\n\n### 4. Billing & Charge Creation\n- **Generates fulfillment charges** for merchant team automatically\n- **Calculates costs** based on package dimensions, weight, and carrier rates\n- **Creates pick charges** if fulfillment type includes picking operations\n- **Applied to merchant team** regardless of package type\n\n### 5. Quantity Management\n- **`FULFILLMENT_ORDER`**: **Decrements remaining quantities** on fulfillment order line items\n- **Creates deducted quantity tracking** for potential restock operations\n- **`STANDALONE`**: No automatic quantity tracking (manual inventory management required)\n\n### 6. Status Updates\n- **Updates package status** to `FULFILLED`\n- **`FULFILLMENT_ORDER`**: Updates fulfillment order status based on remaining quantities\n- **Updates order fulfillment status** (PENDING → PARTIALLY_FULFILLED → FULFILLED)\n\n### 7. Fulfillment Order Allocation\n- **`FULFILLMENT_ORDER`**: **Recalculates allocations** to reflect new fulfilled quantities\n- **Updates allocation tracking** for accurate inventory management\n- **`STANDALONE`**: No allocation processing required\n\n## Package Type Behavior\n- **`FULFILLMENT_ORDER`**: Creates fulfillment + syncs status to external sales channels + manages allocations\n- **`STANDALONE`**: Creates internal fulfillment only (no external sync, no allocation management)\n\n## Lock Requirements\n- **`FULFILLMENT_ORDER`**: `locked_by` is **REQUIRED** (must own fulfillment order lock)\n- **`STANDALONE`**: `locked_by` is **OPTIONAL** (no lock validation required)\n\n## Inventory Management\n- **Default behavior**: This endpoint does **NOT** modify inventory levels\n- **Stock deductions**: Manual inventory management required - handle separately\n- **`FULFILLMENT_ORDER`**: Creates deducted quantity tracking for restock operations\n- **`STANDALONE`**: No automatic inventory tracking", "tags": ["ShipOS Packages"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the package to fulfill", "in": "path", "name": "package_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request body containing `locked_by` identifier", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Omit_APIFulfillPackageInput.package_id_", "description": "Request body containing `locked_by` identifier" } } } } } }, "/shipos/orders": { "post": { "operationId": "CreateOrder", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new order", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The order data to create", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicCreateOrderInput", "description": "The order data to create" } } } } } }, "/shipos/orders/list": { "get": { "operationId": "ListOrders", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicListOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "List orders with the optimized projection and search strategy", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term (minimum 3 characters) to filter by order-number prefix or customer name/email substring", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by order status *(comma-separated for multiple)*", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by payment status *(comma-separated for multiple)*", "in": "query", "name": "payment_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by fulfillment status *(comma-separated for multiple)*", "in": "query", "name": "fulfillment_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by tags *(comma-separated for multiple, returns orders with ANY of the specified tags)*", "in": "query", "name": "tags", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter orders created on or after this date *(ISO 8601 format)*", "in": "query", "name": "created_after", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter orders created on or before this date *(ISO 8601 format)*", "in": "query", "name": "created_before", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter orders updated on or after this date *(ISO 8601 format)*", "in": "query", "name": "updated_after", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter orders updated on or before this date *(ISO 8601 format)*", "in": "query", "name": "updated_before", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "order_number"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/orders/{order_id}": { "get": { "operationId": "GetOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedOrderWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get an order by its ID", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the order to find", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ] }, "delete": { "operationId": "DeleteOrder", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete an order by ID\n\n**Note**: Orders can only be deleted if they are closed (fulfilled or cancelled).\nActive orders cannot be deleted.", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the order to delete", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Edit a manual order\n\nModifies line items of a manual order. You can add, update, or remove items.\nOnly items in OPEN fulfillment orders can be reduced or removed.\nItems in non-OPEN fulfillment orders (IN_PROGRESS, CLOSED, etc.) cannot be modified.\n\n**Note**: Only manual orders can be edited. Orders from external shops (Shopify, etc.)\nmust be edited through their respective platforms.", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the order to edit", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The edit data including updated line items", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditOrderInput", "description": "The edit data including updated line items" } } } } } }, "/shipos/orders/{order_id}/archive": { "post": { "operationId": "ArchiveOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicMinimalOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Archive an order\n\nArchives an order, removing it from the default order list views.\nArchived orders can still be accessed and unarchived later.", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the order to archive", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/orders/{order_id}/unarchive": { "post": { "operationId": "UnarchiveOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicMinimalOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Unarchive an order\n\nRestores an archived order to the active order list.", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the order to unarchive", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/orders/{order_id}/cancel": { "post": { "operationId": "CancelOrder", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Cancel a manual order\n\nCancels a manual order and closes all associated fulfillment orders.\nThis action is irreversible. Fulfillments must be reverted before their parent order can be cancelled.\nOnly manual orders that are not already cancelled and have no active fulfillments can be cancelled.", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the order to cancel", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/orders/{order_id}/priority": { "patch": { "operationId": "UpdateOrderPriority", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicUpdateOrderPriorityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update the priority of an order\n\nChanges the priority level of an order, which affects how orders are prioritized during allocation.\nPriority levels: LOW, NORMAL, HIGH, CRITICAL", "tags": ["ShipOS Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the order to update", "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new priority level", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateOrderPriorityInput", "description": "The new priority level" } } } } } }, "/shipos/locations/{location_id}": { "get": { "operationId": "GetLocation", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocationWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a location by its ID", "tags": ["ShipOS Locations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the location to find", "in": "path", "name": "location_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateLocation", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocation" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a location by ID\n\n**Important validation rules:**\n- Non-sellable locations must be non-pickable\n- STATIC locations cannot have parent locations\n- Only STATIC locations can be marked as hospital locations\n- Hospital locations must be non-pickable and non-sellable", "tags": ["ShipOS Locations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the location to be updated", "in": "path", "name": "location_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the location", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateLocationInput", "description": "The new values for the location" } } } } }, "delete": { "operationId": "DeleteLocation", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a location by ID\n\n**Note:** Locations can only be deleted if they:\n- Have no stock\n- Have no child locations", "tags": ["ShipOS Locations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the location to delete", "in": "path", "name": "location_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/locations": { "post": { "operationId": "CreateLocation", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocation" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new location", "tags": ["ShipOS Locations"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a location", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateLocationInput", "description": "The fields needed to create a location" } } } } }, "get": { "operationId": "GetManyLocations", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyLocationsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple locations with pagination and filtering", "tags": ["ShipOS Locations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter locations by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by location type IDs *(comma-separated for multiple)*", "in": "query", "name": "location_type_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by location kinds *(comma-separated for multiple)*", "in": "query", "name": "location_kind", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by parent location IDs *(comma-separated for multiple)*", "in": "query", "name": "parent_location_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter for hospital locations", "in": "query", "name": "is_hospital", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter for pickable locations", "in": "query", "name": "pickable", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter for sellable locations", "in": "query", "name": "sellable", "required": false, "schema": { "type": "boolean" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "name", "priority"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/locations/{location_id}/move": { "post": { "operationId": "MoveLocation", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocation" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Move a location to a new parent\n\nThis endpoint allows moving `LPN` or `TOTE` locations to a new parent location.\n`STATIC` locations cannot be moved.", "tags": ["ShipOS Locations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the location to move", "in": "path", "name": "location_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new parent location", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMoveLocationInput", "description": "The new parent location" } } } } } }, "/shipos/location-types/{location_type_id}": { "get": { "operationId": "GetLocationType", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocationType" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a location type by its ID", "tags": ["ShipOS Location Types"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the location type to find", "in": "path", "name": "location_type_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateLocationType", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocationType" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a location type by ID", "tags": ["ShipOS Location Types"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the location type to be updated", "in": "path", "name": "location_type_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the location type", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateLocationTypeInput", "description": "The new values for the location type" } } } } }, "delete": { "operationId": "DeleteLocationType", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a location type by ID\n\n**Note:** Location types can only be deleted if they:\n- Are not being used by any locations", "tags": ["ShipOS Location Types"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the location type to delete", "in": "path", "name": "location_type_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/location-types": { "post": { "operationId": "CreateLocationType", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedLocationType" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new location type", "tags": ["ShipOS Location Types"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a location type", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateLocationTypeInput", "description": "The fields needed to create a location type" } } } } }, "get": { "operationId": "GetManyLocationTypes", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_APIExpandedLocationType_" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple location types with pagination and filtering", "tags": ["ShipOS Location Types"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter location types by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/invoices/{invoice_id}": { "get": { "operationId": "GetInvoice", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedInvoiceWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a single invoice by ID", "tags": ["ShipOS Invoices"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the invoice to retrieve", "in": "path", "name": "invoice_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateInvoice", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedInvoice" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update an existing invoice with partial data", "tags": ["ShipOS Invoices"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the invoice to update", "in": "path", "name": "invoice_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateInvoiceInput" } } } } }, "delete": { "operationId": "DeleteInvoice", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "required": ["success"], "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete an invoice by ID", "tags": ["ShipOS Invoices"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the invoice to delete", "in": "path", "name": "invoice_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/invoices": { "get": { "operationId": "GetManyInvoices", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyInvoicesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple invoices with filtering and pagination", "tags": ["ShipOS Invoices"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter invoices by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "name", "total_amount", "start_date", "end_date", "due_date"] } }, { "description": "Sort order - \"asc\" or \"desc\"", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] }, "post": { "operationId": "CreateInvoice", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedInvoice" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new invoice with all related data", "tags": ["ShipOS Invoices"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateInvoiceInput" } } } } } }, "/shipos/fulfillments/{fulfillment_id}": { "get": { "operationId": "GetFulfillment", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFulfillmentWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a fulfillment by its ID", "tags": ["ShipOS Fulfillments"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the fulfillment to find", "in": "path", "name": "fulfillment_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/fulfillments": { "get": { "operationId": "GetManyFulfillments", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyFulfillmentsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple fulfillments with pagination and filtering", "tags": ["ShipOS Fulfillments"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter fulfillments by name or tracking code", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shop IDs *(comma-separated for multiple)*", "in": "query", "name": "shop_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by order IDs *(comma-separated for multiple)*", "in": "query", "name": "order_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by fulfillment order IDs *(comma-separated for multiple)*", "in": "query", "name": "fulfillment_order_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by package IDs *(comma-separated for multiple)*", "in": "query", "name": "package_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by fulfillment status *(comma-separated for multiple)*", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by shipment status *(comma-separated for multiple)*", "in": "query", "name": "shipment_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by fulfillment type *(comma-separated for multiple)*", "in": "query", "name": "type", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by merchant team IDs *(comma-separated for multiple)*", "in": "query", "name": "merchant_team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/fulfillments/{fulfillment_id}/revert": { "post": { "operationId": "RevertFulfillment", "responses": { "200": { "description": "Ok" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Completely reverts a fulfillment and all associated operations:\n\n### 1. Shipping Label Management\n- **Voids shipping label** with the carrier if label exists\n\n### 2. External Sales Channel Cancellation\n- **Cancels remote fulfillment** on connected sales channels (Shopify, BigCommerce, WooCommerce)\n\n### 3. Billing & Charge Reversal\n- **Unallocated charges** (not in invoices): **DELETED** completely\n- **Invoiced charges** (already paid): Creates **CREDIT** charge using `calculated_amount` for refund\n- **Pick charges**: Decrements quantity or deletes if quantity reaches zero\n\n### 4. Quantity Management\n- **Increments remaining quantities** on fulfillment order line items (so order can be fulfilled again)\n- **Decrements deducted quantities** to allow future deductions\n\n### 5. Status Updates\n- **Changes fulfillment status** to `CANCELLED`\n- **Updates package status** to `PENDING`\n- **For `FULFILLMENT_ORDER` packages**: Updates fulfillment order status to `IN_PROGRESS` (so it can be fulfilled again)\n- **Cancelled parent orders**: Cannot be reverted; cancel fulfillments before cancelling the order\n\n### 6. Optional Inventory Restocking\n- **`FULFILLMENT_ORDER`**: **CAN** provide `restock_items` for automatic inventory management\n- **`STANDALONE`**: **CANNOT** provide `restock_items` (throws validation error - manual inventory management required)\n\n## Inventory Management\n- **Default behavior**: This endpoint does NOT modify inventory levels\n- **`FULFILLMENT_ORDER`**: Optionally provide `restock_items` to automatically restock inventory\n- **`STANDALONE`**: Manual inventory management required - handle restocking separately\n- **Quantity limits**: Cannot restock more than was originally deducted during fulfillment", "tags": ["ShipOS Fulfillments"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the fulfillment to revert", "in": "path", "name": "fulfillment_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional restock items to process during revert", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRevertFulfillmentInput", "description": "Optional restock items to process during revert" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}": { "get": { "operationId": "GetFulfillmentOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicExpandedFulfillmentOrderWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a fulfillment order by its ID", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to find", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/fulfillment-orders": { "get": { "operationId": "GetManyFulfillmentOrders", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicGetManyFulfillmentOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple fulfillment orders with pagination and filtering", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter fulfillment orders", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by fulfillment order status *(comma-separated for multiple)*", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by request status *(comma-separated for multiple)*", "in": "query", "name": "request_status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by warehouse IDs *(comma-separated for multiple)*", "in": "query", "name": "warehouse_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by merchant team IDs *(comma-separated for multiple)*", "in": "query", "name": "merchant_team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by batch IDs *(comma-separated for multiple)*", "in": "query", "name": "bulk_ship_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by order IDs *(comma-separated for multiple)*", "in": "query", "name": "order_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "fulfill_by", "fulfilled_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/lock": { "post": { "operationId": "AcquireLock", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIAcquireLockResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:conflict" }, "title": { "type": "string", "example": "Conflict" }, "status": { "type": "integer", "example": 409 }, "detail": { "type": "string", "example": "An order with this reference already exists (Reference this ID for support: trace-789016ghijklmn3)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Acquire a lock on a fulfillment order\n\nAcquires an exclusive lock on a fulfillment order to prevent concurrent fulfillment.\nThe lock will automatically expire after the specified timeout (default 30 minutes).\n\nIf you already own the lock, calling this endpoint will extend the lock duration.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to lock", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIAcquireLockRequest" } } } } }, "delete": { "operationId": "ReleaseLock", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIReleaseLockResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Release a lock on a fulfillment order\n\nReleases a lock on a fulfillment order. This is an idempotent operation -\nif no lock exists, it will return success.\n\nOnly the lock owner can release the lock unless force=true is specified.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to unlock", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIReleaseLockRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/cancellation-requests/accept": { "post": { "operationId": "AcceptCancellationRequest", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIAcceptCancellationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Accept a cancellation request for a fulfillment order\n\nAccepts a cancellation request for a fulfillment order. This will cancel the fulfillment order\nand update its status accordingly.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to accept cancellation for", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIAcceptCancellationRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/cancellation-requests/reject": { "post": { "operationId": "RejectCancellationRequest", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRejectCancellationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Reject a cancellation request for a fulfillment order\n\nRejects a cancellation request for a fulfillment order. This will keep the fulfillment order\nactive and update its status accordingly.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to reject cancellation for", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRejectCancellationRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/fulfillment-requests/submit": { "post": { "operationId": "SubmitFulfillmentRequest", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APISubmitFulfillmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Submit a fulfillment request for a fulfillment order\n\nSubmits a fulfillment request for a fulfillment order. This initiates\nthe fulfillment process for the specified order.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to submit fulfillment request for", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APISubmitFulfillmentRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/fulfillment-requests/accept": { "post": { "operationId": "AcceptFulfillmentRequest", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIAcceptFulfillmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Accept a fulfillment request for a fulfillment order\n\nAccepts a fulfillment request for a fulfillment order. This confirms that\nthe fulfiller will handle the fulfillment of this order.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to accept fulfillment for", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIAcceptFulfillmentRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/fulfillment-requests/reject": { "post": { "operationId": "RejectFulfillmentRequest", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRejectFulfillmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Reject a fulfillment request for a fulfillment order\n\nRejects a fulfillment request for a fulfillment order. This indicates that\nthe fulfiller cannot or will not handle the fulfillment of this order.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to reject fulfillment for", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRejectFulfillmentRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/start": { "post": { "operationId": "StartFulfillment", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIStartFulfillmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Start fulfillment for a fulfillment order\n\nStarts fulfillment for the specified order in one ShipOS operation.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to start", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIStartFulfillmentRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/close": { "post": { "operationId": "CloseFulfillmentOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICloseFulfillmentOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Close a fulfillment order\n\nCloses a fulfillment order, returning it to an unfulfilled state.\nThe order will need another warehouse to accept a new fulfillment request\nbefore it can be fulfilled.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to close", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICloseFulfillmentOrderRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/split": { "post": { "operationId": "SplitFulfillmentOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APISplitFulfillmentOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Split a fulfillment order\n\nSplits a fulfillment order into two separate fulfillment orders.\nSpecify which line items and quantities to move to the new order.\nThe original order will retain the remaining quantities.\n\nAny allocations on the split quantities will be transferred to the new order.\nBoth orders will be re-allocated after the split.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to split", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APISplitFulfillmentOrderRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/merge": { "post": { "operationId": "MergeFulfillmentOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMergeFulfillmentOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Merge a fulfillment order into another\n\nMerges line items from this fulfillment order into a target fulfillment order.\nBoth orders must be from the same order and assigned to the same warehouse.\nThe source order will be closed if all items are merged.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the source fulfillment order (items will be removed from here)", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMergeFulfillmentOrderRequest" } } } } } }, "/shipos/fulfillment-orders/move": { "post": { "operationId": "MoveFulfillmentOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMoveFulfillmentOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Move a fulfillment order to a new warehouse\n\nMoves a fulfillment order (or specific line items) to a new warehouse location.\nSupports full moves (entire order) or partial moves (specific quantities).", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMoveFulfillmentOrderRequest" } } } } } }, "/shipos/fulfillment-orders/{fulfillment_order_id}/carton": { "post": { "operationId": "UpdateCarton", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateCartonResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update carton override on a fulfillment order\n\nSets or clears the carton override for a fulfillment order.\nWhen set, this overrides the default carton selection algorithm.\nPass null to clear the override and use the default algorithm.", "tags": ["ShipOS Fulfillment Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the fulfillment order to update", "in": "path", "name": "fulfillment_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicUpdateCartonRequest" } } } } } }, "/shipos/fulfillment-delegations/{fulfillment_delegation_id}": { "get": { "operationId": "GetFulfillmentDelegation", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFulfillmentDelegationWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a fulfillment delegation by its ID", "tags": ["ShipOS Fulfillment Delegations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the fulfillment delegation to find", "in": "path", "name": "fulfillment_delegation_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateFulfillmentDelegation", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFulfillmentDelegation" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a fulfillment delegation by ID", "tags": ["ShipOS Fulfillment Delegations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the fulfillment delegation to be updated", "in": "path", "name": "fulfillment_delegation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the fulfillment delegation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateFulfillmentDelegationInput", "description": "The new values for the fulfillment delegation" } } } } }, "delete": { "operationId": "DeleteFulfillmentDelegation", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a fulfillment delegation by ID\n\n**Warning:** This permanently deletes the fulfillment delegation and all associated data\nincluding charges, invoices, fulfillment orders, and shipments for this merchant relationship.\nThis action cannot be undone.", "tags": ["ShipOS Fulfillment Delegations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the fulfillment delegation to delete", "in": "path", "name": "fulfillment_delegation_id", "required": true, "schema": { "type": "string" } }, { "description": "Reason for deletion (required for audit logging)", "in": "query", "name": "reason", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "export_archive", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "export_email", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "preserve_stock", "required": false, "schema": { "type": "boolean" } } ] } }, "/shipos/fulfillment-delegations": { "post": { "operationId": "CreateFulfillmentDelegation", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFulfillmentDelegation" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict - Delegation already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new fulfillment delegation\n\nCreates a relationship between a fulfiller team (the caller) and a merchant team.\nOnly one delegation can exist between a specific fulfiller-merchant pair.", "tags": ["ShipOS Fulfillment Delegations"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a fulfillment delegation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateFulfillmentDelegationInput", "description": "The fields needed to create a fulfillment delegation" } } } } }, "get": { "operationId": "GetManyFulfillmentDelegations", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyFulfillmentDelegationsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple fulfillment delegations with pagination and filtering", "tags": ["ShipOS Fulfillment Delegations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter delegations by merchant team name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by payment period *(comma-separated for multiple)*", "in": "query", "name": "payment_period", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "description": "Filter by payment terms *(comma-separated for multiple)*", "in": "query", "name": "payment_terms", "required": false, "schema": { "default": "", "type": "string" } } ] } }, "/shipos/files/{file_id}": { "get": { "operationId": "GetFile", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFileWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a file by its ID", "tags": ["ShipOS Files"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the file to find", "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateFile", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFile" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a file by ID", "tags": ["ShipOS Files"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the file to be updated", "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the file", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateFileInput", "description": "The new values for the file" } } } } }, "delete": { "operationId": "DeleteFile", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a file\n\nDelete a single file by its ID.", "tags": ["ShipOS Files"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the file to delete", "in": "path", "name": "file_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/files": { "post": { "operationId": "CreateFile", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedFile" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new file", "tags": ["ShipOS Files"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a file", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateFileInput", "description": "The fields needed to create a file" } } } } }, "get": { "operationId": "GetManyFiles", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyFilesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple files with pagination and filtering", "tags": ["ShipOS Files"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter files by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by MIME type *(comma-separated for multiple)*", "in": "query", "name": "mimetype", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter files with minimum size in bytes", "in": "query", "name": "min_size", "required": false, "schema": { "default": null, "format": "double", "type": "number" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "name", "size"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/draft-orders": { "post": { "operationId": "CreateDraftOrder", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedDraftOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new draft order", "tags": ["ShipOS Draft Orders"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The draft order data to create", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateDraftOrderInput", "description": "The draft order data to create" } } } } }, "get": { "operationId": "GetManyDraftOrders", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyDraftOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple draft orders with pagination and filtering", "tags": ["ShipOS Draft Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter draft orders by draft number or notes", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by draft order status *(comma-separated for multiple)*", "in": "query", "name": "status", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at", "draft_number"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/shipos/draft-orders/{draft_order_id}": { "get": { "operationId": "GetDraftOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedDraftOrderWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a draft order by its ID", "tags": ["ShipOS Draft Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the draft order to find", "in": "path", "name": "draft_order_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateDraftOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedDraftOrder" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update an existing draft order", "tags": ["ShipOS Draft Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the draft order to update", "in": "path", "name": "draft_order_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The draft order data to update", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateDraftOrderInput", "description": "The draft order data to update" } } } } }, "delete": { "operationId": "DeleteDraftOrder", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a draft order by ID\n\n**Note**: Draft orders can only be deleted if they are not yet converted to orders.\nConverted draft orders cannot be deleted.", "tags": ["ShipOS Draft Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the draft order to delete", "in": "path", "name": "draft_order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/draft-orders/{draft_order_id}/convert": { "post": { "operationId": "ConvertDraftOrder", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertDraftOrderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Convert a draft order to an order\n\nConverts a draft order to a real order that can be fulfilled.\nOnce converted, the draft order cannot be modified.", "tags": ["ShipOS Draft Orders"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the draft order to convert", "in": "path", "name": "draft_order_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/charges": { "get": { "operationId": "GetManyCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyChargesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a list of charges with filtering and pagination", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Search charges by id, name, or description", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter charges by category (comma-separated for multiple values)", "in": "query", "name": "category", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter charges by rate period (comma-separated for multiple values)", "in": "query", "name": "rate_period", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter charges by whether they are allocated to an invoice", "in": "query", "name": "unallocated", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter charges by order ID (comma-separated for multiple values)", "in": "query", "name": "order_id", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Order by field", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "description": "Page number (0-based)", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } } ] } }, "/shipos/charges/{id}": { "get": { "operationId": "GetCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedChargeWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a single charge by ID", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/charges/{charge_id}": { "delete": { "operationId": "DeleteCharge", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a charge by ID\n\nCharges can only be deleted if they are not invoiced.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the charge to delete", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/charges/ad-hoc": { "post": { "operationId": "CreateAdHocCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create an ad-hoc charge\n\nAd-hoc charges are used for one-time or miscellaneous billing items.\nEither fulfillment_delegation_id or merchant_team_id must be provided.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateAdHocChargeInput" } } } } } }, "/shipos/charges/shipping": { "post": { "operationId": "CreateShippingCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a shipping charge\n\nShipping charges are used for shipping label costs.\nEither fulfillment_delegation_id or merchant_team_id must be provided.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateShippingChargeInput" } } } } } }, "/shipos/charges/picking": { "post": { "operationId": "CreatePickingCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a picking charge\n\nPicking charges are used for item picking costs.\nEither fulfillment_delegation_id or merchant_team_id must be provided.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreatePickingChargeInput" } } } } } }, "/shipos/charges/materials": { "post": { "operationId": "CreateMaterialsCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a materials charge\n\nMaterials charges are used for packaging material costs.\nEither fulfillment_delegation_id or merchant_team_id must be provided.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateMaterialsChargeInput" } } } } } }, "/shipos/charges/storage": { "post": { "operationId": "CreateStorageCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a storage charge\n\nStorage charges are used for warehouse storage costs.\nEither fulfillment_delegation_id or merchant_team_id must be provided.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateStorageChargeInput" } } } } } }, "/shipos/charges/credit": { "post": { "operationId": "CreateCreditCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a credit charge\n\nCredit charges are used for discounts or refunds to the merchant.\nEither fulfillment_delegation_id or merchant_team_id must be provided.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateCreditChargeInput" } } } } } }, "/shipos/charges/return-inspection": { "post": { "operationId": "CreateReturnInspectionCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a return inspection charge\n\nReturn inspection charges are used for return processing costs (inspection, restocking, disposal).", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateReturnInspectionChargeInput" } } } } } }, "/shipos/charges/receiving": { "post": { "operationId": "CreateReceivingCharge", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a receiving charge\n\nReceiving charges are used for inbound goods processing costs.", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateReceivingChargeInput" } } } } } }, "/shipos/charges/ad-hoc/{charge_id}": { "patch": { "operationId": "UpdateAdHocCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update an ad-hoc charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the ad-hoc charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateAdHocChargeInput" } } } } } }, "/shipos/charges/shipping/{charge_id}": { "patch": { "operationId": "UpdateShippingCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a shipping charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the shipping charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateShippingChargeInput" } } } } } }, "/shipos/charges/picking/{charge_id}": { "patch": { "operationId": "UpdatePickingCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a picking charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the picking charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdatePickingChargeInput" } } } } } }, "/shipos/charges/materials/{charge_id}": { "patch": { "operationId": "UpdateMaterialsCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a materials charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the materials charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateMaterialsChargeInput" } } } } } }, "/shipos/charges/storage/{charge_id}": { "patch": { "operationId": "UpdateStorageCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a storage charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the storage charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateStorageChargeInput" } } } } } }, "/shipos/charges/credit/{charge_id}": { "patch": { "operationId": "UpdateCreditCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a credit charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the credit charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateCreditChargeInput" } } } } } }, "/shipos/charges/return-inspection/{charge_id}": { "patch": { "operationId": "UpdateReturnInspectionCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a return inspection charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the return inspection charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateReturnInspectionChargeInput" } } } } } }, "/shipos/charges/receiving/{charge_id}": { "patch": { "operationId": "UpdateReceivingCharge", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCharge" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "422": { "description": "Validation Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a receiving charge", "tags": ["ShipOS Charges"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the receiving charge to update", "in": "path", "name": "charge_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateReceivingChargeInput" } } } } } }, "/shipos/carrier-integrations/{carrier_integration_id}": { "get": { "operationId": "GetCarrierIntegration", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCarrierIntegrationWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a carrier integration by its ID", "tags": ["ShipOS Carrier integrations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the carrier integration to find", "in": "path", "name": "carrier_integration_id", "required": true, "schema": { "type": "string" } } ] }, "delete": { "operationId": "DeleteCarrierIntegration", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a carrier integration by ID\n\n**Warning:** This permanently deletes the carrier integration. Some related records\nsuch as carrier accounts, disabled carrier settings, scan forms, and delegation-specific\ndisabled rates will be deleted. Historical records like shipping labels and fulfillment\norders will remain, but their direct carrier integration reference will be cleared.", "tags": ["ShipOS Carrier integrations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the carrier integration to delete", "in": "path", "name": "carrier_integration_id", "required": true, "schema": { "type": "string" } }, { "description": "Reason for deletion (required for audit logging)", "in": "query", "name": "reason", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/carrier-integrations": { "get": { "operationId": "GetManyCarrierIntegrations", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyCarrierIntegrationsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple carrier integrations with pagination and filtering", "tags": ["ShipOS Carrier integrations"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } }, "/merchantos/products": { "get": { "operationId": "GetManyProducts", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_MerchantProduct_" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "List products with pagination and filtering", "tags": ["Merchant Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number (starts at 1)", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter products by name or SKU", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Field to order by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Sort order", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] }, "post": { "operationId": "CreateProduct", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantProduct" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new product", "tags": ["Merchant Products"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a product", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantCreateProductInput", "description": "The fields needed to create a product" } } } } } }, "/merchantos/products/{product_id}": { "get": { "operationId": "GetProduct", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantProduct" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a product by its ID", "tags": ["Merchant Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "UUID of the product to find", "in": "path", "name": "product_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateProduct", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantProduct" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a product by ID\n\n**Important behavior for array fields (bundle_components, assembly_components):**\n- If omitted: Existing components are preserved\n- If empty array `[]`: All components are removed\n- If array with items: All existing components are replaced", "tags": ["Merchant Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the product to be updated", "in": "path", "name": "product_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the product", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantUpdateProductInput", "description": "The new values for the product" } } } } }, "delete": { "operationId": "DeleteProduct", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a product by ID", "tags": ["Merchant Products"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the product to delete", "in": "path", "name": "product_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/vendors/{vendor_id}": { "get": { "operationId": "GetVendor", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIVendorWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "vendor_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateVendor", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIVendor" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "vendor_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSUpdateVendorInput" } } } } }, "delete": { "operationId": "DeleteVendor", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:conflict" }, "title": { "type": "string", "example": "Conflict" }, "status": { "type": "integer", "example": 409 }, "detail": { "type": "string", "example": "An order with this reference already exists (Reference this ID for support: trace-789016ghijklmn3)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "vendor_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/vendors": { "get": { "operationId": "GetManyVendors", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_APIVendorList_" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["ShipOS Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at"] } }, { "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "in": "query", "name": "merchant_team_id", "required": false, "schema": { "default": "", "type": "string" } }, { "in": "query", "name": "product_id", "required": false, "schema": { "default": "", "type": "string" } } ] }, "post": { "operationId": "CreateVendor", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIVendor" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new vendor.\n\nCreates a vendor for the authenticated ShipOS team. When `merchant_team_id`\nis provided, the team must have access to that merchant through an active\nfulfillment delegation.", "summary": "Create a new vendor", "tags": ["ShipOS Vendors"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipOSCreateVendorInput" } } } } } }, "/merchantos/vendors/{vendor_id}": { "get": { "operationId": "GetVendor", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIVendorWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["Merchant Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "vendor_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateVendor", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIVendor" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["Merchant Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "vendor_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantUpdateVendorInput" } } } } }, "delete": { "operationId": "DeleteVendor", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:conflict" }, "title": { "type": "string", "example": "Conflict" }, "status": { "type": "integer", "example": 409 }, "detail": { "type": "string", "example": "An order with this reference already exists (Reference this ID for support: trace-789016ghijklmn3)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["Merchant Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "vendor_id", "required": true, "schema": { "type": "string" } } ] } }, "/merchantos/vendors": { "get": { "operationId": "GetManyVendors", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_APIVendorList_" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "tags": ["Merchant Vendors"], "security": [ { "api_key": [] } ], "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at"] } }, { "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } }, { "in": "query", "name": "product_id", "required": false, "schema": { "default": "", "type": "string" } } ] }, "post": { "operationId": "CreateVendor", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIVendor" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new vendor.\n\nCreates a vendor for the authenticated MerchantOS team.", "summary": "Create a new vendor", "tags": ["Merchant Vendors"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantCreateVendorInput" } } } } } }, "/shipos/cartons/{carton_id}": { "get": { "operationId": "GetCarton", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCartonWithActions" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get a carton by its ID", "tags": ["ShipOS Cartons"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "ID of the carton to find", "in": "path", "name": "carton_id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "operationId": "UpdateCarton", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCarton" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Update a carton by ID", "tags": ["ShipOS Cartons"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the carton to be updated", "in": "path", "name": "carton_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The new values for the carton", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUpdateCartonInput", "description": "The new values for the carton" } } } } }, "delete": { "operationId": "DeleteCarton", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Delete a carton by ID\n\n**Note:** Cartons can only be deleted if they:\n- Are not being used by any packages", "tags": ["ShipOS Cartons"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "The ID of the carton to delete", "in": "path", "name": "carton_id", "required": true, "schema": { "type": "string" } } ] } }, "/shipos/cartons": { "post": { "operationId": "CreateCarton", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIExpandedCarton" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:validation" }, "title": { "type": "string", "example": "Validation Failed" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "One or more fields contain invalid values (Reference this ID for support: trace-2345678901bcdefg)" }, "fields": { "type": "object", "properties": { "quantity": { "type": "string", "example": "Must be a positive integer" }, "product_id": { "type": "string", "example": "Product not found" } }, "required": ["quantity", "product_id"], "additionalProperties": false } }, "required": ["type", "title", "status", "detail", "fields"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Create a new carton", "tags": ["ShipOS Cartons"], "security": [ { "api_key": [] } ], "parameters": [], "requestBody": { "description": "The fields needed to create a carton", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APICreateCartonInput", "description": "The fields needed to create a carton" } } } } }, "get": { "operationId": "GetManyCartons", "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGetManyCartonsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:bad-request" }, "title": { "type": "string", "example": "Bad Request" }, "status": { "type": "integer", "example": 400 }, "detail": { "type": "string", "example": "The provided order_id 'not-a-uuid' is invalid. Expected a valid UUID (Reference this ID for support: trace-1234567890abcdef)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:unauthorized" }, "title": { "type": "string", "example": "Authentication Required" }, "status": { "type": "integer", "example": 401 }, "detail": { "type": "string", "example": "The provided x-access-token API key is invalid (Reference this ID for support: trace-3456789012cdefgh)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:forbidden" }, "title": { "type": "string", "example": "Access Denied" }, "status": { "type": "integer", "example": 403 }, "detail": { "type": "string", "example": "You do not have permission to delete this order (Reference this ID for support: trace-56789014efghijk1)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:not-found" }, "title": { "type": "string", "example": "Resource Not Found" }, "status": { "type": "integer", "example": 404 }, "detail": { "type": "string", "example": "Order with ID '550e8400-e29b-41d4-a716-446655440000' was not found (Reference this ID for support: trace-6789015fghijklm2)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:rate-limit" }, "title": { "type": "string", "example": "Too Many Requests" }, "status": { "type": "integer", "example": 429 }, "detail": { "type": "string", "example": "You have exceeded the rate limit of 120 requests per minute (Reference this ID for support: trace-89017hijklmno4)" }, "limit": { "type": "integer", "example": 120 }, "remaining": { "type": "integer", "example": 0 }, "retry_after": { "type": "integer", "example": 60 } }, "required": ["type", "title", "status", "detail", "limit", "remaining", "retry_after"], "additionalProperties": false } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "example": "urn:cybership:error:internal" }, "title": { "type": "string", "example": "Internal Server Error" }, "status": { "type": "integer", "example": 500 }, "detail": { "type": "string", "example": "An unexpected error occurred while processing your request. Please try again later (Reference this ID for support: trace-9018ijklmnop5)" } }, "required": ["type", "title", "status", "detail"], "additionalProperties": false } } } } }, "description": "Get multiple cartons with pagination and filtering", "tags": ["ShipOS Cartons"], "security": [ { "api_key": [] } ], "parameters": [ { "description": "Page number for pagination *(starting from 0)*", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "double", "type": "number" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "double", "type": "number" } }, { "description": "Search term to filter cartons by name", "in": "query", "name": "search", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by carton name", "in": "query", "name": "name", "required": false, "schema": { "default": "", "type": "string" } }, { "description": "Filter by carton width", "in": "query", "name": "width", "required": false, "schema": { "default": null, "format": "double", "type": "number" } }, { "description": "Filter by carton height", "in": "query", "name": "height", "required": false, "schema": { "default": null, "format": "double", "type": "number" } }, { "description": "Filter by carton length", "in": "query", "name": "length", "required": false, "schema": { "default": null, "format": "double", "type": "number" } }, { "description": "Filter for default cartons", "in": "query", "name": "is_default", "required": false, "schema": { "type": "boolean" } }, { "description": "Field to order results by", "in": "query", "name": "order_by", "required": false, "schema": { "default": "created_at", "type": "string", "enum": ["created_at", "updated_at"] } }, { "description": "Order direction", "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/APISortDirection" } } ] } } }, "servers": [ { "url": "https://api.cybership.io/v1", "description": "Production server" }, { "url": "https://api.cybership.dev/v1", "description": "Staging server" }, { "url": "https://api.cybership.dev/v1", "description": "Development server" }, { "url": "http://localhost:3000/v1", "description": "Local development server" } ] }