{
"openapi": "3.0.3",
"info": {
"title": "Skutopia Internal Gateway API",
"description": "Combined reference for every OpenAPI spec mounted on this gateway.",
"version": "2026-05-19"
},
"servers": [
{
"url": "https://interna-api.skutopia.com/",
"description": "Fulfilment Network API"
}
],
"tags": [],
"paths": {
"/organizations/{organizationId}/warehouses/{warehouseId}/inventory/{barcode}": {
"get": {
"operationId": "inventory-getInventoryLevelByBarcode",
"summary": "Get inventory level by barcode at a warehouse",
"tags": [
"inventory"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "warehouseId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "barcode",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"organizationId": {
"type": "string"
},
"warehouseId": {
"type": "string"
},
"barcode": {
"type": "string"
},
"fulfillable": {
"type": "number"
},
"allocated": {
"type": "number"
},
"pendingAllocation": {
"type": "number"
},
"sellable": {
"type": "number"
},
"onHand": {
"type": "number"
}
},
"required": [
"organizationId",
"warehouseId",
"barcode",
"fulfillable",
"allocated",
"pendingAllocation",
"sellable",
"onHand"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/inventory": {
"get": {
"operationId": "inventory-getAllWarehousesInventoryWithMetadata",
"summary": "Inventory across all warehouses with retail-unit metadata",
"tags": [
"inventory"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"SUCCESS"
]
},
"retailUnitsWithInventory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"barcode": {
"type": "string"
},
"imageSrc": {
"type": "string"
},
"name": {
"type": "string"
},
"sku": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
},
"fulfillable": {
"type": "number"
},
"allocated": {
"type": "number"
},
"pendingAllocation": {
"type": "number"
},
"sellable": {
"type": "number"
},
"onHand": {
"type": "number"
}
},
"required": [
"barcode",
"fulfillable",
"allocated",
"pendingAllocation",
"sellable",
"onHand"
]
}
}
},
"required": [
"outcome",
"retailUnitsWithInventory"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/warehouses/{warehouseId}/inventory": {
"get": {
"operationId": "inventory-getInventoryWithMetadata",
"summary": "Inventory at a warehouse with retail-unit metadata",
"tags": [
"inventory"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "warehouseId",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"SUCCESS"
]
},
"retailUnitsWithInventory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"barcode": {
"type": "string"
},
"imageSrc": {
"type": "string"
},
"name": {
"type": "string"
},
"sku": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
},
"fulfillable": {
"type": "number"
},
"allocated": {
"type": "number"
},
"pendingAllocation": {
"type": "number"
},
"sellable": {
"type": "number"
},
"onHand": {
"type": "number"
}
},
"required": [
"barcode",
"fulfillable",
"allocated",
"pendingAllocation",
"sellable",
"onHand"
]
}
}
},
"required": [
"outcome",
"retailUnitsWithInventory"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/retail-units/{barcode}/archive": {
"post": {
"operationId": "inventory-archiveRetailUnit",
"summary": "Archive a retail unit",
"tags": [
"inventory"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "barcode",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"SUCCESS",
"ARCHIVAL_FAILED"
]
}
},
"required": [
"outcome"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/release-channel": {
"post": {
"operationId": "organization-assignReleaseChannel",
"summary": "Assign a release channel to an organization",
"tags": [
"organization"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"releaseChannel": {
"anyOf": [
{
"type": "string",
"enum": [
"ALPHA"
]
},
{
"type": "string",
"enum": [
"BETA"
]
},
{
"type": "string",
"enum": [
"STABLE"
]
}
]
}
},
"required": [
"releaseChannel"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"success"
]
},
"organizationId": {
"type": "string"
},
"releaseChannel": {
"type": "string"
}
},
"required": [
"outcome",
"organizationId",
"releaseChannel"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}": {
"get": {
"operationId": "organization-getOrganization",
"summary": "Get an organization by id",
"tags": [
"organization"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations": {
"get": {
"operationId": "organization-getAllOrganizationIds",
"summary": "List all organization ids",
"tags": [
"organization"
],
"security": [
{
"Authorization": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/barcode-inventory-sync-overrides": {
"post": {
"operationId": "organization-changeBarcodeInventorySyncOverrides",
"summary": "Change barcode-level inventory sync overrides",
"tags": [
"organization"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"barcodes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"dryRun": {
"type": "boolean"
}
},
"required": [
"barcodes"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/default-inventory-sync": {
"post": {
"operationId": "organization-changeOrganizationDefaultInventorySync",
"summary": "Change the organization-default inventory sync behaviour",
"tags": [
"organization"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string",
"minLength": 1
},
"required": true
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"inventorySyncBarcodeDefault": {
"anyOf": [
{
"type": "string",
"enum": [
"SYNC_ALL_BY_DEFAULT"
]
},
{
"type": "string",
"enum": [
"SYNC_NONE_BY_DEFAULT"
]
}
]
}
},
"required": [
"inventorySyncBarcodeDefault"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/internal-tools/clarify-inventory-levels": {
"post": {
"operationId": "internalTools-clarifyInventoryLevels",
"summary": "Re-clarify inventory levels for a set of barcodes",
"tags": [
"internal-tools"
],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"organizationId": {
"type": "string"
},
"initiator": {
"type": "string"
},
"barcodes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"organizationId",
"initiator",
"barcodes"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"ACKNOWLEDGED"
]
}
},
"required": [
"outcome"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/internal-tools/events": {
"get": {
"operationId": "internalTools-getEventsByEventIds",
"summary": "Get domain events by id",
"tags": [
"internal-tools"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "eventIds",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/internal-tools/events/by-barcode": {
"get": {
"operationId": "internalTools-getPaginatedEventsByBarcode",
"summary": "Paginated domain events for a barcode",
"tags": [
"internal-tools"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "query",
"name": "organizationId",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "query",
"name": "barcode",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "number",
"minimum": 1,
"maximum": 100,
"default": 20
}
},
{
"in": "query",
"name": "timeWindowHours",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "startDate",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "endDate",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/internal-tools/release-channel-features": {
"get": {
"operationId": "internalTools-getReleaseChannelFeatures",
"summary": "List release channel feature flags",
"tags": [
"internal-tools"
],
"security": [
{
"Authorization": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"releaseChannel": {
"type": "string"
}
},
"required": [
"name",
"description",
"releaseChannel"
]
}
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/internal-tools/dispatch-command": {
"post": {
"operationId": "internalTools-dispatchCommand",
"summary": "Manually dispatch an FND command",
"tags": [
"internal-tools"
],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"commandName": {},
"commandBody": {},
"organizationId": {
"type": "string"
}
},
"required": [
"commandName",
"organizationId"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"SUCCESS",
"FAILED"
]
}
},
"required": [
"outcome"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/fulfilment-orders/{fulfilmentOrderId}/cancel": {
"post": {
"operationId": "fulfilmentOrder-cancelFulfilmentOrder",
"summary": "Cancel a fulfilment order",
"tags": [
"fulfilment-order"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "fulfilmentOrderId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": true
}
},
{
"type": "object",
"properties": {
"signalKind": {
"type": "string",
"enum": [
"NO_OP"
]
},
"outcome": {
"type": "string"
}
},
"required": [
"signalKind",
"outcome"
]
}
]
}
},
"required": [
"outcome"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/organizations/{organizationId}/fulfilment-orders/{fulfilmentOrderId}/withdraw": {
"post": {
"operationId": "fulfilmentOrder-withdrawFulfilmentOrderFromWarehouse",
"summary": "Withdraw a fulfilment order from its warehouse",
"tags": [
"fulfilment-order"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "fulfilmentOrderId",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "organizationId",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": true
}
}
},
"required": [
"outcome"
]
}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/fulfilment-orders/{fulfilmentOrderId}/back-order": {
"get": {
"operationId": "fulfilmentOrder-merchantFulfilmentOrdersOnBackOrder",
"summary": "Get back order for a fulfilment order",
"tags": [
"fulfilment-order"
],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"in": "path",
"name": "fulfilmentOrderId",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Invalid input data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.BAD_REQUEST"
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.NOT_FOUND"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
},
"/warehouses": {
"get": {
"operationId": "warehouse-getWarehouses",
"summary": "List configured warehouses",
"tags": [
"warehouse"
],
"security": [
{
"Authorization": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"capabilities": {
"type": "object",
"properties": {
"carrierTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"STANDARD",
"SAME_DAY"
]
}
}
},
"required": [
"carrierTypes"
]
}
},
"required": [
"id",
"name",
"capabilities"
]
}
}
}
}
},
"401": {
"description": "Authorization not provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.UNAUTHORIZED"
}
}
}
},
"403": {
"description": "Insufficient access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.FORBIDDEN"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fnd_error.INTERNAL_SERVER_ERROR"
}
}
}
}
},
"x-zuplo-route": {
"handler": {
"export": "urlForwardHandler",
"module": "$import(@zuplo/runtime)",
"options": {
"baseUrl": "https://fnd-server.skutopia.com"
}
},
"policies": {
"inbound": [
"gateway-api-key",
"fnd-upstream-auth"
]
}
},
"description": "audience:internal"
}
}
},
"components": {
"schemas": {
"fnd_error.BAD_REQUEST": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message",
"example": "Invalid input data"
},
"code": {
"type": "string",
"description": "The error code",
"example": "BAD_REQUEST"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "An array of issues that were responsible for the error",
"example": []
}
},
"required": [
"message",
"code"
],
"title": "Invalid input data error (400)",
"description": "The error information",
"example": {
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}
},
"fnd_error.UNAUTHORIZED": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message",
"example": "Authorization not provided"
},
"code": {
"type": "string",
"description": "The error code",
"example": "UNAUTHORIZED"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "An array of issues that were responsible for the error",
"example": []
}
},
"required": [
"message",
"code"
],
"title": "Authorization not provided error (401)",
"description": "The error information",
"example": {
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}
},
"fnd_error.FORBIDDEN": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message",
"example": "Insufficient access"
},
"code": {
"type": "string",
"description": "The error code",
"example": "FORBIDDEN"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "An array of issues that were responsible for the error",
"example": []
}
},
"required": [
"message",
"code"
],
"title": "Insufficient access error (403)",
"description": "The error information",
"example": {
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}
},
"fnd_error.NOT_FOUND": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message",
"example": "Not found"
},
"code": {
"type": "string",
"description": "The error code",
"example": "NOT_FOUND"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "An array of issues that were responsible for the error",
"example": []
}
},
"required": [
"message",
"code"
],
"title": "Not found error (404)",
"description": "The error information",
"example": {
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}
},
"fnd_error.INTERNAL_SERVER_ERROR": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message",
"example": "Internal server error"
},
"code": {
"type": "string",
"description": "The error code",
"example": "INTERNAL_SERVER_ERROR"
},
"issues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "An array of issues that were responsible for the error",
"example": []
}
},
"required": [
"message",
"code"
],
"title": "Internal server error error (500)",
"description": "The error information",
"example": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}
}
},
"securitySchemes": {
"Authorization": {
"type": "http",
"scheme": "bearer"
}
}
}
}