{ "components": { "securitySchemes": { "bearerAuth": { "description": "Maybox Service Principal의 Bearer 토큰을 보냅니다.", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Maybox Public API", "version": "1.0" }, "openapi": "3.1.0", "paths": { "/api/v1/events": { "get": { "operationId": "v1.event.query.listEvents", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "after", "schema": { "maxLength": 8192, "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "hasMore": { "type": "boolean" }, "items": { "items": { "anyOf": [ { "additionalProperties": false, "properties": { "actionRequired": { "const": false }, "changes": { "anyOf": [ { "prefixItems": [ { "const": "access_granted", "type": "string" } ], "type": "array" }, { "items": { "enum": [ "details", "inbound_links", "photos" ], "type": "string" }, "minItems": 1, "type": "array" } ] }, "eventId": { "maxLength": 200, "minLength": 1, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "payload": { "additionalProperties": false, "properties": { "appearedAt": { "format": "date-time", "type": "string" }, "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "goodsDescription": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "linkedInboundCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "linkedInboundIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "maxItems": 50, "type": "array" }, "linkedInboundIdsTruncated": { "default": false, "type": "boolean" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "quantityDescription": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "recordedAt": { "format": "date-time", "type": "string" }, "revision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "tracking": { "items": { "additionalProperties": false, "properties": { "carrierName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "trackingNumber": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "required": [ "carrierName", "trackingNumber" ], "type": "object" }, "maxItems": 50, "type": "array" }, "trackingCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "trackingTruncated": { "default": false, "type": "boolean" }, "truncatedFields": { "default": [], "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "arrivalId", "revision", "appearedAt", "recordedAt", "note", "goodsDescription", "quantityDescription", "tracking", "trackingCount", "linkedInboundIds", "linkedInboundCount" ], "type": "object" }, "resource": { "additionalProperties": false, "properties": { "apiPath": { "type": "string" }, "id": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "kind": { "const": "arrival", "type": "string" } }, "required": [ "kind", "id", "apiPath" ], "type": "object" }, "schemaVersion": { "const": 1 }, "sequence": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "summary": { "maxLength": 300, "type": "string" }, "type": { "const": "arrival.changed", "type": "string" } }, "required": [ "schemaVersion", "eventId", "sequence", "occurredAt", "summary", "type", "changes", "resource", "actionRequired", "payload" ], "type": "object" }, { "additionalProperties": false, "properties": { "actionRequired": { "const": false }, "changes": { "prefixItems": [ { "const": "access_revoked", "type": "string" } ], "type": "array" }, "eventId": { "maxLength": 200, "minLength": 1, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "payload": { "additionalProperties": false, "properties": { "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "revision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "arrivalId", "revision" ], "type": "object" }, "resource": { "additionalProperties": false, "properties": { "apiPath": { "type": "null" }, "id": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "kind": { "const": "arrival", "type": "string" } }, "required": [ "kind", "id", "apiPath" ], "type": "object" }, "schemaVersion": { "const": 1 }, "sequence": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "summary": { "maxLength": 300, "type": "string" }, "type": { "const": "arrival.changed", "type": "string" } }, "required": [ "schemaVersion", "eventId", "sequence", "occurredAt", "summary", "type", "changes", "resource", "actionRequired", "payload" ], "type": "object" }, { "additionalProperties": false, "properties": { "actionRequired": { "type": "boolean" }, "changes": { "items": { "enum": [ "created", "details", "registration", "confirmation_requested", "confirmed", "confirmation_revoked", "putaway", "photos", "closed", "reopened" ], "type": "string" }, "minItems": 1, "type": "array" }, "eventId": { "maxLength": 200, "minLength": 1, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "payload": { "additionalProperties": false, "properties": { "closedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "externalReference": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "lineCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "lines": { "items": { "additionalProperties": false, "properties": { "autoReservedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "brandName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "cartonMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "completedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "expectedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "pendingAutoReservationQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "registeredQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "requestsCartonMeasurement": { "type": "boolean" }, "requestsUnitMeasurement": { "type": "boolean" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "skuName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "unitMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "unitSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "sku", "skuName", "brandName", "expectedQuantity", "registeredQuantity", "completedQuantity", "autoReservedQuantity", "pendingAutoReservationQuantity", "unitSpecification", "cartonSpecification", "unitMeasurement", "cartonMeasurement", "requestsUnitMeasurement", "requestsCartonMeasurement" ], "type": "object" }, "maxItems": 50, "type": "array" }, "linesTruncated": { "default": false, "type": "boolean" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationConfirmation": { "anyOf": [ { "additionalProperties": false, "properties": { "confirmedAt": { "format": "date-time", "type": "string" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision", "confirmedAt", "note" ], "type": "object" }, { "type": "null" } ] }, "registrationConfirmationRequest": { "anyOf": [ { "additionalProperties": false, "properties": { "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedAt": { "format": "date-time", "type": "string" } }, "required": [ "registrationRevision", "requestedAt" ], "type": "object" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "status": { "enum": [ "OPEN", "CLOSED" ], "type": "string" }, "truncatedFields": { "default": [], "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "inboundId", "externalReference", "status", "registrationRevision", "registrationConfirmationRequest", "registrationConfirmation", "closedAt", "note", "lineCount", "lines" ], "type": "object" }, "resource": { "additionalProperties": false, "properties": { "apiPath": { "type": "string" }, "id": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "kind": { "const": "inbound", "type": "string" } }, "required": [ "kind", "id", "apiPath" ], "type": "object" }, "schemaVersion": { "const": 1 }, "sequence": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "summary": { "maxLength": 300, "type": "string" }, "type": { "const": "inbound.changed", "type": "string" } }, "required": [ "schemaVersion", "eventId", "sequence", "occurredAt", "summary", "type", "changes", "resource", "actionRequired", "payload" ], "type": "object" }, { "additionalProperties": false, "properties": { "actionRequired": { "type": "boolean" }, "changes": { "items": { "enum": [ "submitted", "amended", "review_decided", "review_revoked", "checked", "putaway", "putaway_reversed", "closed", "reopened", "observation_changed" ], "type": "string" }, "minItems": 1, "type": "array" }, "eventId": { "maxLength": 200, "minLength": 1, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "payload": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "status": { "enum": [ "OPEN", "CLOSED" ], "type": "string" }, "workflowRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "status", "workflowRevision" ], "type": "object" }, "resource": { "additionalProperties": false, "properties": { "apiPath": { "type": "string" }, "id": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "kind": { "const": "inbound", "type": "string" } }, "required": [ "kind", "id", "apiPath" ], "type": "object" }, "schemaVersion": { "const": 1 }, "sequence": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "summary": { "maxLength": 300, "type": "string" }, "type": { "const": "inbound.registration.changed", "type": "string" } }, "required": [ "schemaVersion", "eventId", "sequence", "occurredAt", "summary", "type", "changes", "resource", "actionRequired", "payload" ], "type": "object" }, { "additionalProperties": false, "properties": { "actionRequired": { "const": false }, "changes": { "items": { "enum": [ "created", "instructions", "notes", "packing_preparation", "packing", "dispatch_preparation", "dispatch_plan", "dispatch_completed", "domestic_waybills", "photos", "completed", "canceled" ], "type": "string" }, "minItems": 1, "type": "array" }, "eventId": { "maxLength": 200, "minLength": 1, "type": "string" }, "occurredAt": { "format": "date-time", "type": "string" }, "payload": { "additionalProperties": false, "properties": { "canceledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "dispatch": { "anyOf": [ { "additionalProperties": false, "properties": { "carrier": { "anyOf": [ { "enum": [ "FEDEX", "UPS", "DHL" ], "type": "string" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "handoffMethod": { "anyOf": [ { "enum": [ "PICKUP", "PARCEL" ], "type": "string" }, { "type": "null" } ] }, "handoffNote": { "maxLength": 1000, "type": "string" }, "parcelRecipient": { "anyOf": [ { "additionalProperties": false, "properties": { "address": { "maxLength": 500, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "phone": { "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "name", "address", "phone" ], "type": "object" }, { "type": "null" } ] }, "pickupDestination": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "scheduledDispatchDate": { "format": "date-time", "type": "string" } }, "required": [ "dispatchId", "scheduledDispatchDate", "completedAt", "handoffNote", "handoffMethod", "carrier", "parcelRecipient" ], "type": "object" }, { "type": "null" } ] }, "dispatchId": { "anyOf": [ { "pattern": "^[1-9][0-9]*$", "type": "string" }, { "type": "null" } ] }, "dispatchPreparation": { "additionalProperties": false, "properties": { "confirmedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } }, "required": [ "confirmedAt" ], "type": "object" }, "externalReference": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "lineCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "lines": { "items": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "dispatchedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "packedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "requestedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "skuName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] } }, "required": [ "sku", "skuName", "brandName", "requestedQuantity", "packedQuantity", "dispatchedQuantity" ], "type": "object" }, "maxItems": 50, "type": "array" }, "linesTruncated": { "default": false, "type": "boolean" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "packing": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } }, "required": [ "completedAt" ], "type": "object" }, "packingPreparation": { "additionalProperties": false, "properties": { "status": { "enum": [ "NOT_REQUIRED", "PENDING", "COMPLETED" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "status": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "truncatedFields": { "default": [], "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "outboundId", "externalReference", "status", "canceledAt", "completedAt", "note", "packingPreparation", "packing", "dispatchPreparation", "lineCount", "lines", "dispatchId", "dispatch" ], "type": "object" }, "resource": { "additionalProperties": false, "properties": { "apiPath": { "type": "string" }, "id": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "kind": { "const": "outbound", "type": "string" } }, "required": [ "kind", "id", "apiPath" ], "type": "object" }, "schemaVersion": { "const": 1 }, "sequence": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "summary": { "maxLength": 300, "type": "string" }, "type": { "const": "outbound.changed", "type": "string" } }, "required": [ "schemaVersion", "eventId", "sequence", "occurredAt", "summary", "type", "changes", "resource", "actionRequired", "payload" ], "type": "object" } ] }, "maxItems": 100, "type": "array" }, "nextCursor": { "maxLength": 8192, "minLength": 1, "type": "string" }, "windowCursor": { "maxLength": 8192, "minLength": 1, "type": "string" } }, "required": [ "items", "nextCursor", "hasMore", "windowCursor" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "EVENT.INVALID_CURSOR" }, "data": {}, "defined": { "const": true }, "message": { "default": "EVENT.INVALID_CURSOR", "type": "string" }, "status": { "const": 400 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "400" }, "410": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "EVENT.CURSOR_EXPIRED" }, "data": { "additionalProperties": false, "properties": { "recoveryCursor": { "maxLength": 8192, "minLength": 1, "type": "string" } }, "required": [ "recoveryCursor" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "EVENT.CURSOR_EXPIRED", "type": "string" }, "status": { "const": 410 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "410" } }, "security": [ { "bearerAuth": [] } ], "summary": "이벤트 목록 조회", "tags": [ "이벤트" ] } }, "/api/v1/events/checkpoint": { "get": { "operationId": "v1.event.query.getEventCheckpoint", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "cursor": { "maxLength": 8192, "minLength": 1, "type": "string" } }, "required": [ "cursor", "createdAt" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "이벤트 체크포인트 조회", "tags": [ "이벤트" ] } }, "/api/v1/inbounds": { "post": { "operationId": "v1.inbound.command.createInbound", "parameters": [ { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": false, "properties": { "expectedDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "externalReference": { "minLength": 1, "type": "string" }, "lines": { "items": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, "expectedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "pendingAutoReservationQuantity": { "default": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "productBarcodes": { "default": [], "items": { "minLength": 1, "type": "string" }, "maxItems": 1, "type": "array" }, "requestsCartonMeasurement": { "type": "boolean" }, "requestsUnitMeasurement": { "type": "boolean" }, "requiresUnitMeasurement": { "type": "boolean" }, "sku": { "minLength": 1, "type": "string" }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "unitSpecification": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" } }, "required": [ "sku", "expectedQuantity", "requestsCartonMeasurement" ], "type": "object" }, "minItems": 1, "type": "array" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lines" ], "type": "object" }, { "additionalProperties": false, "properties": { "expectedDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "externalReference": { "minLength": 1, "type": "string" }, "lines": { "items": { "additionalProperties": false, "properties": { "catalog": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, "productBarcode": { "minLength": 1, "type": "string" }, "skuName": { "minLength": 1, "type": "string" }, "unitSpecification": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" } }, "required": [ "skuName", "brandName" ], "type": "object" }, "expectedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "pendingAutoReservationQuantity": { "default": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestsCartonMeasurement": { "type": "boolean" }, "requestsUnitMeasurement": { "type": "boolean" }, "requiresUnitMeasurement": { "type": "boolean" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "expectedQuantity", "requestsCartonMeasurement", "catalog" ], "type": "object" }, "minItems": 1, "type": "array" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lines" ], "type": "object" } ] } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId" ], "type": "object" } } }, "description": "OK" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.DUPLICATE_SKU" }, "data": { "additionalProperties": false, "properties": { "skus": { "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "skus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.DUPLICATE_SKU", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.AUTO_RESERVATION_EXCEEDS_REMAINING_QUANTITY" }, "data": { "additionalProperties": false, "properties": { "violations": { "items": { "additionalProperties": false, "properties": { "maximumPendingQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedPendingQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "requestedPendingQuantity", "maximumPendingQuantity" ], "type": "object" }, "type": "array" } }, "required": [ "violations" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.AUTO_RESERVATION_EXCEEDS_REMAINING_QUANTITY", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 생성", "tags": [ "입고" ] } }, "/api/v1/inbounds/{inboundId}": { "put": { "operationId": "v1.inbound.command.updateInboundDetails", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expectedDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "expectedDate", "note" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "INBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "OPEN", "CLOSED" ], "type": "string" }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 상세 갱신", "tags": [ "입고" ] } }, "/api/v1/inbounds/{inboundId}/automatic-reservations": { "put": { "operationId": "v1.inbound.command.updateAutomaticReservations", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "automaticReservations": { "items": { "additionalProperties": false, "properties": { "pendingAutoReservationQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "pendingAutoReservationQuantity" ], "type": "object" }, "type": "array" } }, "required": [ "automaticReservations" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId" ], "type": "object" } } }, "description": "OK" }, "404": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "INBOUND.LINE_NOT_FOUND" }, "data": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "inboundId", "sku" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.LINE_NOT_FOUND", "type": "string" }, "status": { "const": 404 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "404" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "INBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "OPEN", "CLOSED" ], "type": "string" }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.AUTO_RESERVATION_EXCEEDS_REMAINING_QUANTITY" }, "data": { "additionalProperties": false, "properties": { "violations": { "items": { "additionalProperties": false, "properties": { "maximumPendingQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedPendingQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "requestedPendingQuantity", "maximumPendingQuantity" ], "type": "object" }, "type": "array" } }, "required": [ "violations" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.AUTO_RESERVATION_EXCEEDS_REMAINING_QUANTITY", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 자동 예약 갱신", "tags": [ "입고" ] } }, "/api/v1/inbounds/{inboundId}/closure": { "post": { "operationId": "v1.inbound.command.closeInbound", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "reason": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "closedAt": { "format": "date-time", "type": "string" }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "outcome": { "description": "CLOSED_WITHOUT_REGISTRATION: 활성 Batch 등록 없이 닫음 · CLOSED_AFTER_PUTAWAY: 등록 전량 적재 뒤 적재한 만큼으로 닫음 · ALREADY_CLOSED: 이미 닫혀 있어 바꾸지 않음", "enum": [ "CLOSED_WITHOUT_REGISTRATION", "CLOSED_AFTER_PUTAWAY", "ALREADY_CLOSED" ], "type": "string" } }, "required": [ "inboundId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "INBOUND.PUTAWAY_NOT_FINISHED" }, "data": { "additionalProperties": false, "description": "창고가 등록했지만 아직 적재하지 않은 수량(적재 되돌리기를 뺀 순 적재 기준)이 남아 닫을 수 없다", "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "remainingQuantity": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "remainingQuantity" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.PUTAWAY_NOT_FINISHED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "RELEASE_TRANSITION.PENDING" }, "data": { "additionalProperties": false, "properties": { "targetVersion": { "type": "string" } }, "required": [ "targetVersion" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "RELEASE_TRANSITION.PENDING", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 마감", "tags": [ "입고" ] } }, "/api/v1/outbounds": { "get": { "operationId": "v1.outbound.query.listOutbounds", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "status", "schema": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "externalReference", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "createdAt": { "format": "date-time", "type": "string" }, "externalReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lineCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "status": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" } }, "required": [ "outboundId", "externalReference", "status", "lineCount", "createdAt" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "출고 목록 조회", "tags": [ "출고" ] }, "post": { "operationId": "v1.outbound.command.createOutbound", "parameters": [ { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": false, "properties": { "dispatchPreparationConfirmationPolicy": { "enum": [ "NOT_REQUIRED", "CONFIRMATION_REQUIRED" ], "type": "string" }, "externalReference": { "minLength": 1, "type": "string" }, "lines": { "items": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, "quantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "unitLabelingTasks": { "default": [], "items": { "additionalProperties": false, "properties": { "attachmentInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "labelFiles": { "items": { "additionalProperties": false, "properties": { "fileName": { "minLength": 1, "type": "string" }, "fileUrl": { "format": "uri", "type": "string" } }, "required": [ "fileName", "fileUrl" ], "type": "object" }, "minItems": 1, "type": "array" }, "labelName": { "minLength": 1, "type": "string" }, "labelUrl": { "format": "uri", "type": "string" } }, "required": [ "labelName" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "dispatchPreparationConfirmationPolicy", "lines" ], "type": "object" }, { "additionalProperties": false, "properties": { "dispatchPreparationConfirmationPolicy": { "enum": [ "NOT_REQUIRED", "CONFIRMATION_REQUIRED" ], "type": "string" }, "externalReference": { "minLength": 1, "type": "string" }, "lines": { "items": { "additionalProperties": false, "properties": { "cartonSpecification": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, "catalog": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, "productBarcode": { "minLength": 1, "type": "string" }, "skuName": { "minLength": 1, "type": "string" }, "unitSpecification": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" } }, "required": [ "skuName", "brandName" ], "type": "object" }, "quantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "unitLabelingTasks": { "default": [], "items": { "additionalProperties": false, "properties": { "attachmentInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "labelFiles": { "items": { "additionalProperties": false, "properties": { "fileName": { "minLength": 1, "type": "string" }, "fileUrl": { "format": "uri", "type": "string" } }, "required": [ "fileName", "fileUrl" ], "type": "object" }, "minItems": 1, "type": "array" }, "labelName": { "minLength": 1, "type": "string" }, "labelUrl": { "format": "uri", "type": "string" } }, "required": [ "labelName" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "quantity", "catalog" ], "type": "object" }, "minItems": 1, "type": "array" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "dispatchPreparationConfirmationPolicy", "lines" ], "type": "object" } ] } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId" ], "type": "object" } } }, "description": "OK" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "TASK_FILE.UPLOAD_INVALID" }, "data": {}, "defined": { "const": true }, "message": { "default": "TASK_FILE.UPLOAD_INVALID", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "OUTBOUND.DUPLICATE_SKU" }, "data": { "additionalProperties": false, "properties": { "skus": { "items": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "type": "array" } }, "required": [ "skus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.DUPLICATE_SKU", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "OUTBOUND.INSUFFICIENT_RESERVED_QUANTITY" }, "data": { "additionalProperties": false, "properties": { "shortages": { "items": { "additionalProperties": false, "properties": { "requestedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "unusedReservedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "sku", "requestedQuantity", "unusedReservedQuantity" ], "type": "object" }, "type": "array" } }, "required": [ "shortages" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.INSUFFICIENT_RESERVED_QUANTITY", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "출고 생성", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}": { "get": { "operationId": "v1.outbound.query.getOutbound", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "canceledAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "dispatchPreparation": { "additionalProperties": false, "properties": { "confirmedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "documentAttachmentTasks": { "items": { "additionalProperties": false, "properties": { "attachmentInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attachmentTarget": { "enum": [ "ALL_PACKAGES", "ALL_PALLETS" ], "type": "string" }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "documentAttachmentTaskId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "documentFiles": { "items": { "additionalProperties": false, "properties": { "fileName": { "minLength": 1, "type": "string" }, "fileUrl": { "format": "uri", "type": "string" } }, "required": [ "fileName", "fileUrl" ], "type": "object" }, "type": "array" }, "documentName": { "minLength": 1, "type": "string" }, "documentUrl": { "format": "uri", "type": "string" }, "printMedia": { "enum": [ "PLAIN_PAPER", "ADHESIVE_LABEL" ], "type": "string" } }, "required": [ "documentAttachmentTaskId", "documentName", "documentFiles", "documentUrl", "attachmentTarget", "printMedia", "attachmentInstructions", "completedAt" ], "type": "object" }, "type": "array" }, "palletization": { "anyOf": [ { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "maxPalletHeightMm": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "palletizationInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pallets": { "items": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "packageIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "minItems": 1, "type": "array" }, "palletId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "grossWeightG", "palletId", "packageIds" ], "type": "object" }, "type": "array" } }, "required": [ "maxPalletHeightMm", "palletizationInstructions", "completedAt", "pallets" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "confirmedAt", "palletization", "documentAttachmentTasks" ], "type": "object" }, "dispatchPreparationConfirmationPolicy": { "enum": [ "NOT_REQUIRED", "CONFIRMATION_REQUIRED" ], "type": "string" }, "dispatches": { "items": { "anyOf": [ { "additionalProperties": false, "properties": { "carrier": { "anyOf": [ { "enum": [ "FEDEX", "UPS", "DHL" ], "type": "string" }, { "type": "null" } ] }, "completedAt": { "type": "null" }, "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "handoffMethod": { "anyOf": [ { "enum": [ "PICKUP", "PARCEL" ], "type": "string" }, { "type": "null" } ] }, "handoffNote": { "maxLength": 1000, "minLength": 1, "type": "string" }, "parcelRecipient": { "anyOf": [ { "additionalProperties": false, "properties": { "address": { "maxLength": 500, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "phone": { "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "name", "address", "phone" ], "type": "object" }, { "type": "null" } ] }, "pickupDestination": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "scheduledDispatchDate": { "format": "date-time", "type": "string" } }, "required": [ "scheduledDispatchDate", "handoffNote", "handoffMethod", "carrier", "parcelRecipient", "dispatchId", "completedAt" ], "type": "object" }, { "additionalProperties": false, "properties": { "carrier": { "anyOf": [ { "enum": [ "FEDEX", "UPS", "DHL" ], "type": "string" }, { "type": "null" } ] }, "completedAt": { "format": "date-time", "type": "string" }, "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "dispatchedPackageIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "minItems": 1, "type": "array" }, "handoffMethod": { "anyOf": [ { "enum": [ "PICKUP", "PARCEL" ], "type": "string" }, { "type": "null" } ] }, "handoffNote": { "maxLength": 1000, "minLength": 1, "type": "string" }, "parcelRecipient": { "anyOf": [ { "additionalProperties": false, "properties": { "address": { "maxLength": 500, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "phone": { "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "name", "address", "phone" ], "type": "object" }, { "type": "null" } ] }, "pickupDestination": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "scheduledDispatchDate": { "format": "date-time", "type": "string" } }, "required": [ "scheduledDispatchDate", "handoffNote", "handoffMethod", "carrier", "parcelRecipient", "dispatchId", "completedAt", "dispatchedPackageIds" ], "type": "object" }, { "additionalProperties": false, "properties": { "carrier": { "anyOf": [ { "enum": [ "FEDEX", "UPS", "DHL" ], "type": "string" }, { "type": "null" } ] }, "completedAt": { "format": "date-time", "type": "string" }, "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "dispatchedPalletIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "minItems": 1, "type": "array" }, "handoffMethod": { "anyOf": [ { "enum": [ "PICKUP", "PARCEL" ], "type": "string" }, { "type": "null" } ] }, "handoffNote": { "maxLength": 1000, "minLength": 1, "type": "string" }, "parcelRecipient": { "anyOf": [ { "additionalProperties": false, "properties": { "address": { "maxLength": 500, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "phone": { "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "name", "address", "phone" ], "type": "object" }, { "type": "null" } ] }, "pickupDestination": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "scheduledDispatchDate": { "format": "date-time", "type": "string" } }, "required": [ "scheduledDispatchDate", "handoffNote", "handoffMethod", "carrier", "parcelRecipient", "dispatchId", "completedAt", "dispatchedPalletIds" ], "type": "object" } ] }, "type": "array" }, "externalReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lineCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "lines": { "items": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "dispatchedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "latestCartonMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "latestUnitMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "packedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "requestedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "skuName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "unitLabelingTasks": { "items": { "additionalProperties": false, "properties": { "attachmentInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "labelFiles": { "items": { "additionalProperties": false, "properties": { "fileName": { "minLength": 1, "type": "string" }, "fileUrl": { "format": "uri", "type": "string" } }, "required": [ "fileName", "fileUrl" ], "type": "object" }, "type": "array" }, "labelName": { "minLength": 1, "type": "string" }, "labelUrl": { "format": "uri", "type": "string" }, "unitLabelingTaskId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "unitLabelingTaskId", "labelName", "labelFiles", "labelUrl", "attachmentInstructions", "completedAt" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "skuName", "brandName", "requestedQuantity", "packedQuantity", "dispatchedQuantity", "cartonSpecification", "latestUnitMeasurement", "latestCartonMeasurement", "unitLabelingTasks" ], "type": "object" }, "type": "array" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "packing": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "packages": { "items": { "additionalProperties": false, "properties": { "kind": { "enum": [ "BOX", "CARTON" ], "type": "string" }, "packageBarcode": { "maxLength": 64, "minLength": 1, "pattern": "^[\\x21-\\x7e]+$", "type": "string" }, "packageBatches": { "items": { "additionalProperties": false, "properties": { "batchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "quantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" } }, "required": [ "batchId", "sku", "quantity" ], "type": "object" }, "type": "array" }, "packageId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "packageSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "packageId", "packageBarcode", "kind", "packageBatches", "packageSpecification" ], "type": "object" }, "type": "array" } }, "required": [ "completedAt", "packages" ], "type": "object" }, "packingPreparation": { "additionalProperties": false, "properties": { "status": { "enum": [ "NOT_REQUIRED", "PENDING", "COMPLETED" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "status": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" } }, "required": [ "outboundId", "externalReference", "status", "lineCount", "createdAt", "dispatchPreparationConfirmationPolicy", "note", "canceledAt", "completedAt", "lines", "packingPreparation", "packing", "dispatchPreparation", "dispatches" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "출고 상세 조회", "tags": [ "출고" ] }, "put": { "operationId": "v1.outbound.command.updateOutboundDetails", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "note" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "출고 상세 갱신", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/cancellation": { "post": { "operationId": "v1.outbound.command.cancelOutbound", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "canceledAt": { "format": "date-time", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "canceledAt" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.NOT_CANCELABLE" }, "data": { "additionalProperties": false, "properties": { "completedDispatchCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus", "completedDispatchCount" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.NOT_CANCELABLE", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "출고 취소", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/dispatch-preparation": { "put": { "operationId": "v1.outbound.command.updateDispatchPreparationInstructions", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "palletization": { "anyOf": [ { "additionalProperties": false, "properties": { "maxPalletHeightMm": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "palletizationInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "maxPalletHeightMm", "palletizationInstructions" ], "type": "object" }, { "type": "null" } ] }, "pendingDocumentAttachmentTasks": { "items": { "additionalProperties": false, "properties": { "attachmentInstructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attachmentTarget": { "enum": [ "ALL_PACKAGES", "ALL_PALLETS" ], "type": "string" }, "documentAttachmentTaskId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "documentFiles": { "items": { "additionalProperties": false, "properties": { "fileName": { "minLength": 1, "type": "string" }, "fileUrl": { "format": "uri", "type": "string" } }, "required": [ "fileName", "fileUrl" ], "type": "object" }, "minItems": 1, "type": "array" }, "documentName": { "minLength": 1, "type": "string" }, "documentUrl": { "format": "uri", "type": "string" }, "printMedia": { "enum": [ "PLAIN_PAPER", "ADHESIVE_LABEL" ], "type": "string" } }, "required": [ "documentName", "attachmentTarget", "printMedia", "attachmentInstructions" ], "type": "object" }, "type": "array" } }, "required": [ "palletization", "pendingDocumentAttachmentTasks" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "DISPATCH_PREPARATION.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "confirmationPolicy": { "enum": [ "NOT_REQUIRED", "CONFIRMATION_REQUIRED" ], "type": "string" }, "confirmedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "dispatchPreparationId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "dispatchPreparationId", "confirmationPolicy", "confirmedAt" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "DISPATCH_PREPARATION.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "PALLETIZATION.HAS_PALLETS" }, "data": { "additionalProperties": false, "properties": { "palletIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "minItems": 1, "type": "array" }, "palletizationId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "palletizationId", "palletIds" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "PALLETIZATION.HAS_PALLETS", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "DOCUMENT_ATTACHMENT.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "dispatchPreparationConfirmedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "documentAttachmentTaskId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "documentAttachmentTaskId", "completedAt", "dispatchPreparationConfirmedAt" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "DOCUMENT_ATTACHMENT.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "TASK_FILE.UPLOAD_INVALID" }, "data": {}, "defined": { "const": true }, "message": { "default": "TASK_FILE.UPLOAD_INVALID", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "인계 준비 지시 갱신", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/dispatch-preparation/confirmation": { "post": { "operationId": "v1.outbound.command.confirmDispatchPreparation", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "confirmedAt": { "format": "date-time", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "confirmedAt" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "DISPATCH_PREPARATION.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "confirmationPolicy": { "enum": [ "NOT_REQUIRED", "CONFIRMATION_REQUIRED" ], "type": "string" }, "confirmedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "dispatchPreparationId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "dispatchPreparationId", "confirmationPolicy", "confirmedAt" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "DISPATCH_PREPARATION.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "PACKING.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED" ], "type": "string" }, "packingId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "packingId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "PACKING.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "인계 준비 확인", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/dispatch-preparation/confirmation/revocation": { "post": { "operationId": "v1.outbound.command.revokeDispatchPreparationConfirmation", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expectedConfirmedAt": { "format": "date-time", "type": "string" }, "reason": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "expectedConfirmedAt", "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "revokedAt": { "format": "date-time", "type": "string" } }, "required": [ "outboundId", "revokedAt" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "DISPATCH_PREPARATION.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "confirmationPolicy": { "enum": [ "NOT_REQUIRED", "CONFIRMATION_REQUIRED" ], "type": "string" }, "confirmedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "dispatchPreparationId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "dispatchPreparationId", "confirmationPolicy", "confirmedAt" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "DISPATCH_PREPARATION.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "OUTBOUND.PHYSICAL_STRUCTURE_LOCKED" }, "data": { "additionalProperties": false, "properties": { "completedAt": { "format": "date-time", "type": "string" }, "firstCompletedDispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "firstCompletedDispatchId", "completedAt" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.PHYSICAL_STRUCTURE_LOCKED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "인계 준비 확인 취소", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/dispatches": { "post": { "operationId": "v1.outbound.command.createDispatch", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "carrier": { "enum": [ "FEDEX", "UPS", "DHL" ], "type": "string" }, "handoffMethod": { "enum": [ "PICKUP", "PARCEL" ], "type": "string" }, "handoffNote": { "maxLength": 1000, "minLength": 1, "type": "string" }, "parcelRecipient": { "additionalProperties": false, "properties": { "address": { "maxLength": 500, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "phone": { "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "name", "address", "phone" ], "type": "object" }, "pickupDestination": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "scheduledDispatchDate": { "format": "date-time", "type": "string" } }, "required": [ "scheduledDispatchDate", "handoffNote" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "dispatchId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "인계 생성", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/dispatches/{dispatchId}": { "delete": { "operationId": "v1.outbound.command.deleteDispatch", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "in": "path", "name": "dispatchId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "dispatchId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "DISPATCH.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED" ], "type": "string" }, "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "dispatchId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "DISPATCH.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "인계 삭제", "tags": [ "출고" ] }, "put": { "operationId": "v1.outbound.command.updateDispatchPlan", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "in": "path", "name": "dispatchId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "carrier": { "enum": [ "FEDEX", "UPS", "DHL" ], "type": "string" }, "handoffMethod": { "enum": [ "PICKUP", "PARCEL" ], "type": "string" }, "handoffNote": { "maxLength": 1000, "minLength": 1, "type": "string" }, "parcelRecipient": { "additionalProperties": false, "properties": { "address": { "maxLength": 500, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "phone": { "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "name", "address", "phone" ], "type": "object" }, "pickupDestination": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "scheduledDispatchDate": { "format": "date-time", "type": "string" } }, "required": [ "scheduledDispatchDate", "handoffNote" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "dispatchId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "OUTBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "CANCELED" ], "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "outboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "OUTBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "DISPATCH.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "IN_PROGRESS", "COMPLETED" ], "type": "string" }, "dispatchId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "dispatchId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "DISPATCH.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "인계 갱신", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/domestic-waybills": { "get": { "operationId": "v1.outbound.query.listDomesticWaybills", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "waybills": { "items": { "additionalProperties": false, "properties": { "number": { "maxLength": 80, "minLength": 1, "type": "string" }, "packageId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "packageId", "number" ], "type": "object" }, "type": "array" } }, "required": [ "waybills" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "국내 운송장 목록 조회", "tags": [ "출고" ] } }, "/api/v1/outbounds/{outboundId}/photos": { "get": { "operationId": "v1.photo.query.listOutboundPhotos", "parameters": [ { "in": "path", "name": "outboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "byteSize": { "exclusiveMinimum": 0, "maximum": 20971520, "minimum": -9007199254740991, "type": "integer" }, "captureContext": { "enum": [ "PACKING_PREPARATION", "PACKING", "DISPATCH_PREPARATION", "DISPATCH" ], "type": "string" }, "contentType": { "const": "image/jpeg", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "heightPx": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "photoId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "viewUrl": { "format": "uri", "type": "string" }, "viewUrlExpiresAt": { "format": "date-time", "type": "string" }, "widthPx": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "photoId", "note", "widthPx", "heightPx", "byteSize", "contentType", "createdAt", "viewUrl", "viewUrlExpiresAt", "outboundId", "captureContext" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "출고 사진 목록 조회", "tags": [ "사진" ] } }, "/api/v1/skus": { "get": { "operationId": "v1.sku.query.listSkus", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "sku", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "search", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "historyStartedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "productBarcode": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "sku": { "minLength": 1, "type": "string" }, "skuId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "tenantId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "tenantKey": { "minLength": 1, "type": "string" }, "unitSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" }, { "type": "null" } ] }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "skuId", "tenantId", "tenantKey", "sku", "skuName", "brandName", "createdAt", "updatedAt", "productBarcode", "unitSpecification", "cartonSpecification", "historyStartedAt" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "상품 목록 조회", "tags": [ "상품" ] }, "post": { "operationId": "v1.sku.command.createSku", "parameters": [ { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "sku": { "minLength": 1, "type": "string" }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "sku", "skuName", "brandName" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "skuId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "skuId" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU.ALREADY_EXISTS" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU.ALREADY_EXISTS", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "상품 생성", "tags": [ "상품" ] } }, "/api/v1/skus/{skuId}": { "delete": { "operationId": "v1.sku.command.deleteSku", "parameters": [ { "in": "path", "name": "skuId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "skuId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "skuId" ], "type": "object" } } }, "description": "OK" }, "404": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU.NOT_FOUND" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU.NOT_FOUND", "type": "string" }, "status": { "const": 404 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "404" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "상품 삭제", "tags": [ "상품" ] }, "get": { "operationId": "v1.sku.query.getSku", "parameters": [ { "in": "path", "name": "skuId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "historyStartedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "productBarcode": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "sku": { "minLength": 1, "type": "string" }, "skuId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "tenantId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "tenantKey": { "minLength": 1, "type": "string" }, "unitSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" }, { "type": "null" } ] }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "skuId", "tenantId", "tenantKey", "sku", "skuName", "brandName", "createdAt", "updatedAt", "productBarcode", "unitSpecification", "cartonSpecification", "historyStartedAt" ], "type": "object" } } }, "description": "OK" }, "404": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU.NOT_FOUND" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU.NOT_FOUND", "type": "string" }, "status": { "const": 404 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "404" } }, "security": [ { "bearerAuth": [] } ], "summary": "상품 상세 조회", "tags": [ "상품" ] }, "put": { "operationId": "v1.sku.command.updateSku", "parameters": [ { "in": "path", "name": "skuId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "required": [ "skuName", "brandName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "skuId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "skuId" ], "type": "object" } } }, "description": "OK" }, "404": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU.NOT_FOUND" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU.NOT_FOUND", "type": "string" }, "status": { "const": 404 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "404" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "상품 갱신", "tags": [ "상품" ] } }, "/api/v1/skus/{skuId}/changes": { "get": { "operationId": "v1.sku.query.listSkuChanges", "parameters": [ { "in": "path", "name": "skuId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "after": { "anyOf": [ { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "productBarcode": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "unitSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "skuName", "brandName", "productBarcode", "unitSpecification", "cartonSpecification" ], "type": "object" }, { "type": "null" } ] }, "appliedAt": { "format": "date-time", "type": "string" }, "before": { "anyOf": [ { "additionalProperties": false, "properties": { "brandName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "productBarcode": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "skuName": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "unitSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "skuName", "brandName", "productBarcode", "unitSpecification", "cartonSpecification" ], "type": "object" }, { "type": "null" } ] }, "changeId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "source": { "anyOf": [ { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "kind": { "const": "INBOUND", "type": "string" } }, "required": [ "kind", "inboundId" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "OUTBOUND", "type": "string" }, "outboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "kind", "outboundId" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "DIRECT", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "INITIALIZATION", "type": "string" } }, "required": [ "kind" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } } }, "required": [ "changeId", "appliedAt", "source", "before", "after" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" }, "404": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU.NOT_FOUND" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU.NOT_FOUND", "type": "string" }, "status": { "const": 404 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "404" } }, "security": [ { "bearerAuth": [] } ], "summary": "상품 변경 이력 조회", "tags": [ "상품" ] } }, "/api/v1/stock": { "get": { "operationId": "v1.stock.query.listStock", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "sku", "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "items": { "minLength": 1, "type": "string" }, "type": "array" } ] } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "stock", "schema": { "enum": [ "ON_HAND", "AVAILABLE" ], "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "availableQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "onHandQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "outboundShortageQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "reservationExcessQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "reservedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "securedOutboundQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" }, "unusedReservedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "sku", "onHandQuantity", "reservedQuantity", "availableQuantity", "securedOutboundQuantity", "unusedReservedQuantity", "reservationExcessQuantity", "outboundShortageQuantity" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "재고 목록 조회", "tags": [ "재고" ] } }, "/api/v1/stock/reservation-releases": { "post": { "operationId": "v1.stock.command.releaseReservedQuantity", "parameters": [ { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "quantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "reservationEventId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "reservationEventId" ], "type": "object" } } }, "description": "OK" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "RESERVATION.INSUFFICIENT_UNUSED_RESERVED_QUANTITY" }, "data": { "additionalProperties": false, "properties": { "requestedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" }, "unusedReservedQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "sku", "requestedQuantity", "unusedReservedQuantity" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "RESERVATION.INSUFFICIENT_UNUSED_RESERVED_QUANTITY", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "예약 재고 해제", "tags": [ "재고" ] } }, "/api/v1/stock/reservations": { "post": { "operationId": "v1.stock.command.reserveQuantity", "parameters": [ { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "quantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "reservationEventId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "reservationEventId" ], "type": "object" } } }, "description": "OK" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "RESERVATION.INSUFFICIENT_AVAILABLE_QUANTITY" }, "data": { "additionalProperties": false, "properties": { "availableQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "sku": { "minLength": 1, "type": "string" } }, "required": [ "sku", "requestedQuantity", "availableQuantity" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "RESERVATION.INSUFFICIENT_AVAILABLE_QUANTITY", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "재고 예약", "tags": [ "재고" ] } }, "/api/v2/arrivals": { "get": { "operationId": "v2.arrival.query.listArrivals", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "trackingNumber", "schema": { "maxLength": 1000, "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "header", "name": "x-maybox-arrival-closure", "schema": { "const": "ACTIVE", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "appearedAt": { "format": "date-time", "type": "string" }, "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "goodsDescription": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "linkedInboundIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "type": "array" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "quantityDescription": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "recordedAt": { "format": "date-time", "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "tracking": { "items": { "additionalProperties": false, "properties": { "carrierName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "trackingNumber": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "required": [ "carrierName", "trackingNumber" ], "type": "object" }, "type": "array" } }, "required": [ "arrivalId", "appearedAt", "recordedAt", "note", "goodsDescription", "quantityDescription", "tracking", "linkedInboundIds", "revision" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "도착 목록 조회", "tags": [ "도착" ] } }, "/api/v2/arrivals/{arrivalId}": { "get": { "operationId": "v2.arrival.query.getArrival", "parameters": [ { "in": "path", "name": "arrivalId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "appearedAt": { "format": "date-time", "type": "string" }, "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "goodsDescription": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "linkedInboundIds": { "items": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "type": "array" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "quantityDescription": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "recordedAt": { "format": "date-time", "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "tracking": { "items": { "additionalProperties": false, "properties": { "carrierName": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "trackingNumber": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "required": [ "carrierName", "trackingNumber" ], "type": "object" }, "type": "array" } }, "required": [ "arrivalId", "appearedAt", "recordedAt", "note", "goodsDescription", "quantityDescription", "tracking", "linkedInboundIds", "revision" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "도착 상세 조회", "tags": [ "도착" ] } }, "/api/v2/arrivals/{arrivalId}/inbounds/{inboundId}": { "delete": { "operationId": "v2.arrival.command.unlinkInbound", "parameters": [ { "in": "path", "name": "arrivalId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expectedRevision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "expectedRevision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "arrivalId", "revision" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "ARRIVAL.REVISION_CHANGED" }, "data": {}, "defined": { "const": true }, "message": { "default": "ARRIVAL.REVISION_CHANGED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "도착에서 입고 연결 해제", "tags": [ "도착" ] }, "post": { "operationId": "v2.arrival.command.linkInbound", "parameters": [ { "in": "path", "name": "arrivalId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expectedRevision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "expectedRevision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "arrivalId", "revision" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "ARRIVAL.REVISION_CHANGED" }, "data": {}, "defined": { "const": true }, "message": { "default": "ARRIVAL.REVISION_CHANGED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "const": "ARRIVAL.CLOSED" }, "data": {}, "defined": { "const": true }, "message": { "default": "ARRIVAL.CLOSED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "도착에 입고 연결", "tags": [ "도착" ] } }, "/api/v2/arrivals/{arrivalId}/photos": { "get": { "operationId": "v2.photo.query.listArrivalPhotos", "parameters": [ { "in": "path", "name": "arrivalId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "arrivalId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "byteSize": { "exclusiveMinimum": 0, "maximum": 20971520, "minimum": -9007199254740991, "type": "integer" }, "captureContext": { "const": "ARRIVAL", "type": "string" }, "contentType": { "const": "image/jpeg", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "heightPx": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "photoId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "viewUrl": { "format": "uri", "type": "string" }, "viewUrlExpiresAt": { "format": "date-time", "type": "string" }, "widthPx": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "photoId", "note", "widthPx", "heightPx", "byteSize", "contentType", "createdAt", "viewUrl", "viewUrlExpiresAt", "arrivalId", "captureContext" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "도착 사진 목록 조회", "tags": [ "사진" ] } }, "/api/v2/inbounds": { "get": { "operationId": "v2.inbound.query.listInbounds", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "status", "schema": { "enum": [ "OPEN", "CLOSED" ], "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "externalReference", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "closedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "expectedDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "externalReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "lineCount": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "registrationConfirmation": { "anyOf": [ { "additionalProperties": false, "properties": { "confirmedAt": { "format": "date-time", "type": "string" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision", "confirmedAt", "note" ], "type": "object" }, { "type": "null" } ] }, "registrationConfirmationRequest": { "anyOf": [ { "additionalProperties": false, "properties": { "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedAt": { "format": "date-time", "type": "string" } }, "required": [ "registrationRevision", "requestedAt" ], "type": "object" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "registrationWorkflow": { "const": "WHOLE", "type": "string" }, "status": { "enum": [ "OPEN", "CLOSED" ], "type": "string" } }, "required": [ "inboundId", "registrationRevision", "registrationConfirmationRequest", "registrationConfirmation", "closedAt", "externalReference", "status", "expectedDate", "lineCount", "createdAt" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 목록 조회", "tags": [ "입고" ] } }, "/api/v2/inbounds/{inboundId}": { "get": { "operationId": "v2.inbound.query.getInbound", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "closedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "expectedDate": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "externalReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "lineCount": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lines": { "items": { "additionalProperties": false, "properties": { "autoReservedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "brandName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cartonMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "cartonSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG" ], "type": "object" }, { "type": "null" } ] }, "completedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "expectedQuantity": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "latestCartonMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "latestUnitMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "pendingAutoReservationQuantity": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "productBarcodes": { "items": { "minLength": 1, "type": "string" }, "type": "array" }, "registeredQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "requestsCartonMeasurement": { "type": "boolean" }, "requestsUnitMeasurement": { "type": "boolean" }, "sku": { "minLength": 1, "type": "string" }, "skuName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "unitMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "unitSpecification": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "sku", "skuName", "brandName", "expectedQuantity", "registeredQuantity", "completedQuantity", "autoReservedQuantity", "pendingAutoReservationQuantity", "productBarcodes", "unitSpecification", "cartonSpecification", "requestsUnitMeasurement", "requestsCartonMeasurement", "latestUnitMeasurement", "latestCartonMeasurement", "unitMeasurement", "cartonMeasurement" ], "type": "object" }, "type": "array" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "registrationConfirmation": { "anyOf": [ { "additionalProperties": false, "properties": { "confirmedAt": { "format": "date-time", "type": "string" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision", "confirmedAt", "note" ], "type": "object" }, { "type": "null" } ] }, "registrationConfirmationRequest": { "anyOf": [ { "additionalProperties": false, "properties": { "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedAt": { "format": "date-time", "type": "string" } }, "required": [ "registrationRevision", "requestedAt" ], "type": "object" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "registrationWorkflow": { "const": "WHOLE", "type": "string" }, "status": { "enum": [ "OPEN", "CLOSED" ], "type": "string" } }, "required": [ "inboundId", "registrationRevision", "registrationConfirmationRequest", "registrationConfirmation", "closedAt", "externalReference", "status", "expectedDate", "lineCount", "createdAt", "note", "lines" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 상세 조회", "tags": [ "입고" ] } }, "/api/v2/inbounds/{inboundId}/photos": { "get": { "operationId": "v2.photo.query.listInboundPhotos", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "byteSize": { "exclusiveMinimum": 0, "maximum": 20971520, "minimum": -9007199254740991, "type": "integer" }, "captureContext": { "enum": [ "GOODS", "CARTON_LABEL" ], "type": "string" }, "contentType": { "const": "image/jpeg", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "heightPx": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "photoId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "viewUrl": { "format": "uri", "type": "string" }, "viewUrlExpiresAt": { "format": "date-time", "type": "string" }, "widthPx": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "photoId", "note", "widthPx", "heightPx", "byteSize", "contentType", "createdAt", "viewUrl", "viewUrlExpiresAt", "inboundId", "captureContext" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 사진 목록 조회", "tags": [ "사진" ] } }, "/api/v2/inbounds/{inboundId}/registration-confirmation": { "post": { "operationId": "v2.inbound.command.confirmInboundRegistration", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "closedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "registrationConfirmation": { "anyOf": [ { "additionalProperties": false, "properties": { "confirmedAt": { "format": "date-time", "type": "string" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision", "confirmedAt", "note" ], "type": "object" }, { "type": "null" } ] }, "registrationConfirmationRequest": { "anyOf": [ { "additionalProperties": false, "properties": { "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedAt": { "format": "date-time", "type": "string" } }, "required": [ "registrationRevision", "requestedAt" ], "type": "object" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "registrationRevision", "registrationConfirmationRequest", "registrationConfirmation", "closedAt" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "RELEASE_TRANSITION.PENDING" }, "data": { "additionalProperties": false, "properties": { "targetVersion": { "type": "string" } }, "required": [ "targetVersion" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "RELEASE_TRANSITION.PENDING", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "OPEN", "CLOSED" ], "type": "string" }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.REGISTRATION_CHANGED" }, "data": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "registrationRevision" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.REGISTRATION_CHANGED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.REGISTRATION_NOT_REQUESTED" }, "data": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "registrationRevision" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.REGISTRATION_NOT_REQUESTED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 등록 확인", "tags": [ "입고" ] } }, "/api/v2/inbounds/{inboundId}/registration-confirmation/revocation": { "post": { "operationId": "v2.inbound.command.revokeInboundRegistrationConfirmation", "parameters": [ { "in": "path", "name": "inboundId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "closedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "registrationConfirmation": { "anyOf": [ { "additionalProperties": false, "properties": { "confirmedAt": { "format": "date-time", "type": "string" }, "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "registrationRevision", "confirmedAt", "note" ], "type": "object" }, { "type": "null" } ] }, "registrationConfirmationRequest": { "anyOf": [ { "additionalProperties": false, "properties": { "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" }, "requestedAt": { "format": "date-time", "type": "string" } }, "required": [ "registrationRevision", "requestedAt" ], "type": "object" }, { "type": "null" } ] }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "registrationRevision", "registrationConfirmationRequest", "registrationConfirmation", "closedAt" ], "type": "object" } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "RELEASE_TRANSITION.PENDING" }, "data": { "additionalProperties": false, "properties": { "targetVersion": { "type": "string" } }, "required": [ "targetVersion" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "RELEASE_TRANSITION.PENDING", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.STATE_CONFLICT" }, "data": { "additionalProperties": false, "properties": { "currentStatus": { "enum": [ "OPEN", "CLOSED" ], "type": "string" }, "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, "required": [ "inboundId", "currentStatus" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "const": "INBOUND.REGISTRATION_CHANGED" }, "data": { "additionalProperties": false, "properties": { "inboundId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "registrationRevision": { "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "inboundId", "registrationRevision" ], "type": "object" }, "defined": { "const": true }, "message": { "default": "INBOUND.REGISTRATION_CHANGED", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message", "data" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "입고 등록 확인 취소", "tags": [ "입고" ] } }, "/api/v2/sku-measurement-requests": { "get": { "operationId": "v2.skuMeasurementRequest.query.listSkuMeasurementRequests", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "sku", "schema": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "status", "schema": { "enum": [ "REQUESTED", "COMPLETED", "UNAVAILABLE", "CANCELED" ], "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "minLength": 1, "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "items": { "items": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "type": "null" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "REQUESTED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "const": "UNIT", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "CARTON", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "COMPLETED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "additionalProperties": false, "properties": { "explanation": { "maxLength": 500, "minLength": 1, "type": "string" }, "reason": { "enum": [ "NO_STOCK", "NO_CARTON", "OTHER" ], "type": "string" } }, "required": [ "reason" ], "type": "object" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "UNAVAILABLE", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "CANCELED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" } ], "discriminator": { "propertyName": "status" } }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "SKU 실측 요청 목록 조회", "tags": [ "SKU 실측 요청" ] }, "post": { "operationId": "v2.skuMeasurementRequest.command.requestSkuMeasurement", "parameters": [ { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" } }, "required": [ "sku", "kind" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "const": "AVAILABLE", "type": "string" }, "measurement": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "const": "UNIT", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "CARTON", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } } }, "required": [ "kind", "measurement" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "REQUESTED", "type": "string" }, "request": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "type": "null" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "REQUESTED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "const": "UNIT", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "CARTON", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "COMPLETED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "additionalProperties": false, "properties": { "explanation": { "maxLength": 500, "minLength": 1, "type": "string" }, "reason": { "enum": [ "NO_STOCK", "NO_CARTON", "OTHER" ], "type": "string" } }, "required": [ "reason" ], "type": "object" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "UNAVAILABLE", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "CANCELED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" } ], "discriminator": { "propertyName": "status" } } }, "required": [ "kind", "request" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU_MEASUREMENT_REQUEST.STATE_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU_MEASUREMENT_REQUEST.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "SKU 실측 요청 생성", "tags": [ "SKU 실측 요청" ] } }, "/api/v2/sku-measurement-requests/{requestId}": { "get": { "operationId": "v2.skuMeasurementRequest.query.getSkuMeasurementRequest", "parameters": [ { "in": "path", "name": "requestId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "type": "null" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "REQUESTED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "const": "UNIT", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "CARTON", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "COMPLETED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "additionalProperties": false, "properties": { "explanation": { "maxLength": 500, "minLength": 1, "type": "string" }, "reason": { "enum": [ "NO_STOCK", "NO_CARTON", "OTHER" ], "type": "string" } }, "required": [ "reason" ], "type": "object" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "UNAVAILABLE", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "CANCELED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" } ], "discriminator": { "propertyName": "status" } } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "SKU 실측 요청 상세 조회", "tags": [ "SKU 실측 요청" ] } }, "/api/v2/sku-measurement-requests/{requestId}/cancel": { "post": { "operationId": "v2.skuMeasurementRequest.command.cancelSkuMeasurementRequest", "parameters": [ { "in": "path", "name": "requestId", "required": true, "schema": { "pattern": "^[1-9][0-9]*$", "type": "string" } }, { "description": "같은 command 재시도에는 같은 키를 보냅니다.", "in": "header", "name": "idempotency-key", "required": true, "schema": { "maxLength": 255, "pattern": "^[!-~]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "type": "null" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "REQUESTED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "const": "UNIT", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "CARTON", "type": "string" }, "measurement": { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" } }, "required": [ "kind", "measurement" ], "type": "object" } ], "discriminator": { "propertyName": "kind" } }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "COMPLETED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "additionalProperties": false, "properties": { "explanation": { "maxLength": 500, "minLength": 1, "type": "string" }, "reason": { "enum": [ "NO_STOCK", "NO_CARTON", "OTHER" ], "type": "string" } }, "required": [ "reason" ], "type": "object" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "UNAVAILABLE", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "enum": [ "UNIT", "CARTON" ], "type": "string" }, "outcome": { "type": "null" }, "requestId": { "pattern": "^[1-9][0-9]*$", "type": "string" }, "requestedAt": { "format": "date-time", "type": "string" }, "resolvedAt": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "status": { "const": "CANCELED", "type": "string" } }, "required": [ "requestId", "sku", "kind", "requestedAt", "status", "resolvedAt", "outcome" ], "type": "object" } ], "discriminator": { "propertyName": "status" } } } }, "description": "OK" }, "409": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "SKU_MEASUREMENT_REQUEST.STATE_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "SKU_MEASUREMENT_REQUEST.STATE_CONFLICT", "type": "string" }, "status": { "const": 409 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "409" }, "422": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "code": { "const": "IDEMPOTENCY.KEY_CONFLICT" }, "data": {}, "defined": { "const": true }, "message": { "default": "IDEMPOTENCY.KEY_CONFLICT", "type": "string" }, "status": { "const": 422 } }, "required": [ "defined", "code", "status", "message" ], "type": "object" }, { "properties": { "code": { "type": "string" }, "data": {}, "defined": { "const": false }, "message": { "type": "string" }, "status": { "type": "number" } }, "required": [ "defined", "code", "status", "message" ], "type": "object" } ] } } }, "description": "422" } }, "security": [ { "bearerAuth": [] } ], "summary": "SKU 실측 요청 취소", "tags": [ "SKU 실측 요청" ] } }, "/api/v2/sku-measurements/latest": { "get": { "operationId": "v2.skuMeasurement.query.getLatestSkuMeasurements", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "sku", "required": true, "schema": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "latestCartonMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "grossWeightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "unitsPerCarton": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "unitsPerCarton", "lengthMm", "widthMm", "heightMm", "grossWeightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] }, "latestUnitMeasurement": { "anyOf": [ { "additionalProperties": false, "properties": { "heightMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "lengthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "measuredAt": { "format": "date-time", "type": "string" }, "weightG": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" }, "widthMm": { "exclusiveMinimum": 0, "maximum": 2147483647, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "lengthMm", "widthMm", "heightMm", "weightG", "measuredAt" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "latestUnitMeasurement", "latestCartonMeasurement" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "최신 SKU 실측 조회", "tags": [ "SKU 실측" ] } }, "/api/v2/stock/on-hand": { "get": { "operationId": "v2.stock.query.listOnHand", "parameters": [ { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "sku", "schema": { "anyOf": [ { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, { "items": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" }, "type": "array" } ] } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "expirationBefore", "schema": { "format": "date", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "includeUnknown", "schema": { "anyOf": [ { "type": "boolean" }, { "enum": [ "true", "false" ], "type": "string" } ] } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "include", "schema": { "enum": [ "expirationBreakdown", "availabilityBreakdown" ], "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "cursor", "schema": { "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z0-9_-]*$", "type": "string" } }, { "allowEmptyValue": true, "allowReserved": true, "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "asOf": { "format": "date-time", "type": "string" }, "items": { "items": { "additionalProperties": false, "properties": { "availableQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "expirationBreakdown": { "items": { "additionalProperties": false, "properties": { "availableQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "expirationDate": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "onHandQuantity": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "expirationDate", "onHandQuantity" ], "type": "object" }, "type": "array" }, "onHandQuantity": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "reservedQuantity": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sku": { "maxLength": 64, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "type": "string" } }, "required": [ "sku", "onHandQuantity" ], "type": "object" }, "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "asOf", "items", "nextCursor" ], "type": "object" } } }, "description": "OK" } }, "security": [ { "bearerAuth": [] } ], "summary": "현재고 목록 조회", "tags": [ "재고" ] } } }, "servers": [ { "url": "https://api.maybox.app" } ] }