{ "openapi": "3.0.3", "info": { "title": "Cart APIs", "version": "1.0.0", "description": "This is an api to manage draft order operations shopping cart operations", "contact": { "name": "Omni API Support", "email": "DL-OmniAdapter@att.com" } }, "servers": [ { "url": "https://partner.att.com/omni-svcs" } ], "tags": [ { "name": "Shopping Cart", "description": "APIs for managing shopping cart operations" } ], "paths": { "/v1/order/create": { "post": { "tags": [ "Shopping Cart" ], "summary": "Create order", "description": "Create an order in shopping cart with optional cart items", "operationId": "createOrder", "requestBody": { "description": "Request body description", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "object", "properties": { "id": { "type": "string", "example": "IND" }, "name": { "type": "string", "example": "IND" }, "extensions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Application" }, "value": { "type": "string", "example": "bestbuyMST" } } } } } }, "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "productOrderItemId": { "type": "string", "example": "random uuid uniquely identifying a line 10000001-3f41-49bf-a6cf-6f65caa650ca" }, "rootBundleProductOrderItemId": { "type": "string", "example": "Id of parent productOrderItemId 0b690f7e-3f41-49bf-a6cf-6f65caa650ca" }, "productOfferingType": { "type": "string", "example": "Mobile_Device" }, "productOfferingId": { "type": "string", "example": "Mobile_Device_pkey73001_sku2680262" }, "action": { "type": "string", "example": "add" }, "actionReason": { "type": "object", "properties": { "reasonText": { "type": "string", "example": "Memo text required if selected" }, "name": { "type": "string", "example": "LC" }, "action": { "type": "string", "example": "add" } } }, "billingAccount": { "type": "object", "properties": { "ratingType": { "type": "string", "example": "postpaid" }, "id": { "type": "string", "example": "556165899573" } } }, "product": { "type": "object", "properties": { "place": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "440104980" }, "name": { "type": "string", "example": "ppuAddress" }, "role": { "type": "string", "example": "PPU" } } } } } } } } ] } }, "relatedParty": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "referredType": { "type": "string", "example": "individual" }, "role": { "type": "string", "example": "owner" }, "id": { "type": "string", "example": "2f3ca666-744d-4aa3-9351-e259185a065b" } } }, { "type": "object", "properties": { "name": { "type": "string", "example": "RS and I Inc" }, "referredType": { "type": "string", "example": "dealerLocation" }, "id": { "type": "string", "example": "G5MGG" }, "role": { "type": "string", "example": "partner" } } }, { "type": "object", "properties": { "referredType": { "type": "string", "example": "customer" }, "role": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "3f7f9189-974e-4639-8343-4a1819a98c7e" }, "extensions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "CustomerType" }, "value": { "type": "string", "example": "Consumer" } } }, { "type": "object", "properties": { "name": { "type": "string", "example": "CustomerSubType" }, "value": { "type": "string", "example": "Individual" } } } ] } } } } ] } } } }, "examples": { "create-empty-cart": { "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "Application", "value": "bestbuyMST" } ] }, "relatedParty": [ { "referredType": "individual", "role": "owner", "id": "2f3ca666-744d-4aa3-9351-e259185a065b" }, { "name": "RS and I Inc", "referredType": "dealerLocation", "id": "G5MGG", "role": "partner" }, { "referredType": "customer", "role": "customer", "id": "3f7f9189-974e-4639-8343-4a1819a98c7e", "extensions": [ { "name": "CustomerType", "value": "Consumer" }, { "name": "CustomerSubType", "value": "Individual" } ] } ] } }, "create cart with items": { "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "Application", "value": "bestbuyMST" } ] }, "items": [ { "productOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "productOfferingType": "Mobile_Offer", "product": { "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] }, "quantity": 1, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "productOfferingId": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca", "action": "noChange" }, { "productOfferingType": "Mobile_Device", "productOfferingId": "Mobile_Device_pkey73001_sku2680262", "action": "add", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC", "action": "add" }, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "product": { "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] } } ], "relatedParty": [ { "referredType": "individual", "role": "owner", "id": "2f3ca666-744d-4aa3-9351-e259185a065b" }, { "name": "RS and I Inc", "referredType": "dealerLocation", "id": "G5MGG", "role": "partner" }, { "referredType": "customer", "role": "customer", "id": "3f7f9189-974e-4639-8343-4a1819a98c7e", "extensions": [ { "name": "CustomerType", "value": "Consumer" }, { "name": "CustomerSubType", "value": "Individual" } ] } ] } }, "byod-device": { "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "Application", "value": "bestbuyMST" } ] }, "items": [ { "productOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "productOfferingType": "Mobile_Offer", "product": { "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] }, "quantity": 1, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "productOfferingId": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca", "action": "noChange" }, { "productOfferingType": "Mobile_Device", "action": "add", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC", "action": "add" }, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "product": { "productCharacteristic": [ { "name": "IMEI", "value": "1111111222222" } ], "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] } }, { "productOfferingType": "SIM", "productOfferingId": "790650ec-b512-4bee-ae7f-535668eadf1b", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "action": "add", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC" }, "characteristic": [ { "name": "ICCID", "value": "89014103270197479933" } ] } ], "relatedParty": [ { "referredType": "individual", "role": "owner", "id": "2f3ca666-744d-4aa3-9351-e259185a065b" }, { "name": "RS and I Inc", "referredType": "dealerLocation", "id": "G5MGG", "role": "partner" }, { "referredType": "customer", "role": "customer", "id": "3f7f9189-974e-4639-8343-4a1819a98c7e", "extensions": [ { "name": "CustomerType", "value": "Consumer" }, { "name": "CustomerSubType", "value": "Individual" } ] } ] } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "26-46236265737394" } } } } } } } } }, "/v1/order/{orderId}/items": { "post": { "tags": [ "Shopping Cart" ], "summary": "Add item to cart", "description": "Add an item to the shopping cart", "operationId": "addItemToCart", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "example": "26-46236265737394" } } ], "requestBody": { "description": "Request body description", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "productOrderItemId": { "type": "string", "example": "random uuid uniquely identifying a line 10000001-3f41-49bf-a6cf-6f65caa650ca" }, "productOfferingType": { "type": "string", "example": "Mobile_Offer" }, "product": { "type": "object", "properties": { "place": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "440104980" }, "name": { "type": "string", "example": "ppuAddress" }, "role": { "type": "string", "example": "PPU" } } } } } }, "quantity": { "type": "number", "example": 1 }, "billingAccount": { "type": "object", "properties": { "ratingType": { "type": "string", "example": "postpaid" }, "id": { "type": "string", "example": "556165899573" } } }, "productOfferingId": { "type": "string", "example": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca" }, "action": { "type": "string", "example": "noChange" } } }, { "type": "object", "properties": { "productOfferingType": { "type": "string", "example": "Mobile_Device" }, "productOfferingId": { "type": "string", "example": "Mobile_Device_pkey73001_sku2680262" }, "action": { "type": "string", "example": "add" }, "rootBundleProductOrderItemId": { "type": "string", "example": "10000001-3f41-49bf-a6cf-6f65caa650ca" }, "actionReason": { "type": "object", "properties": { "reasonText": { "type": "string", "example": "Memo text required if selected" }, "name": { "type": "string", "example": "LC" }, "action": { "type": "string", "example": "add" } } }, "billingAccount": { "type": "object", "properties": { "ratingType": { "type": "string", "example": "postpaid" }, "id": { "type": "string", "example": "556165899573" } } }, "product": { "type": "object", "properties": { "place": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "440104980" }, "name": { "type": "string", "example": "ppuAddress" }, "role": { "type": "string", "example": "PPU" } } } } } } } } ] } } } }, "examples": { "device-swap": { "value": { "items": [ { "action": "noChange", "productOfferingType": "Mobile_Offer", "productOfferingId": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca", "productOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "subscriberNumber": "4690002221" }, { "productOfferingType": "Mobile_Device", "action": "terminate", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC" }, "product": { "id": "47777581441708014", "primaryProductId": "47777581441708014" } }, { "action": "swap;add", "productOfferingType": "Mobile_Device", "productOfferingId": "Mobile_Device_pkey73001_sku2680262", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC", "action": "swap" }, "product": { "place": [ { "role": "PPU", "name": "ppuAddress", "id": "000011VYAA" } ] }, "characteristic": [ { "name": "isBYOD", "value": "true" }, { "name": "IMEI", "value": "358073464620280" }, { "name": "eSIM_Enabled", "value": "true" } ] }, { "productOfferingType": "SIM", "action": "terminate", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC" }, "product": { "id": "47777581441708014", "primaryProductId": "47777581441708014" } }, { "productOfferingType": "SIM", "productOfferingId": "790650ec-b512-4bee-ae7f-535668eadf1b", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "action": "swap;add", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC" }, "characteristic": [ { "name": "ICCID", "value": "89014103270197479933" } ] } ] } }, "add-a-line": { "value": { "items": [ { "productOrderItemId": "11111111-3f41-49bf-a6cf-6f65caa650ca", "productOfferingType": "Mobile_Offer", "product": { "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] }, "quantity": 1, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "productOfferingId": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca", "action": "noChange" }, { "productOfferingType": "Mobile_Device", "productOfferingId": "Mobile_Device_pkey73001_sku2680262", "action": "add", "rootBundleProductOrderItemId": "11111111-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC", "action": "add" }, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "product": { "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] } } ] } }, "byod-device": { "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "Application", "value": "bestbuyMST" } ] }, "items": [ { "productOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "productOfferingType": "Mobile_Offer", "product": { "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] }, "quantity": 1, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "productOfferingId": "0b690f7e-3f41-49bf-a6cf-6f65caa650ca", "action": "noChange" }, { "productOfferingType": "Mobile_Device", "action": "add", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC", "action": "add" }, "billingAccount": { "ratingType": "postpaid", "id": "556165899573" }, "product": { "productCharacteristic": [ { "name": "IMEI", "value": "1111111222222" } ], "place": [ { "id": "440104980", "name": "ppuAddress", "role": "PPU" } ] } }, { "productOfferingType": "SIM", "productOfferingId": "790650ec-b512-4bee-ae7f-535668eadf1b", "rootBundleProductOrderItemId": "10000001-3f41-49bf-a6cf-6f65caa650ca", "action": "add", "actionReason": { "reasonText": "Memo text required if selected", "name": "LC" }, "characteristic": [ { "name": "ICCID", "value": "89014103270197479933" } ] } ], "relatedParty": [ { "referredType": "individual", "role": "owner", "id": "2f3ca666-744d-4aa3-9351-e259185a065b" }, { "name": "RS and I Inc", "referredType": "dealerLocation", "id": "G5MGG", "role": "partner" }, { "referredType": "customer", "role": "customer", "id": "3f7f9189-974e-4639-8343-4a1819a98c7e", "extensions": [ { "name": "CustomerType", "value": "Consumer" }, { "name": "CustomerSubType", "value": "Individual" } ] } ] } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "26-46236265737394" } } } } } } } }, "delete": { "tags": [ "Shopping Cart" ], "summary": "Delete all item from cart", "description": "Delete all item from cart", "operationId": "deleteItemsfromCart", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "example": "26-46236265737394" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "26-46236265737394" } } } } } } } } }, "/v1/order/{orderId}/items/{productOrderItemId}": { "delete": { "tags": [ "Shopping Cart" ], "summary": "Delete one item from cart", "description": "Delete specific item from cart", "operationId": "deleteItemfromCart", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "example": "26-46236265737394" } }, { "name": "productOrderItemId", "in": "path", "required": true, "schema": { "type": "string", "example": "UUID number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "26-46236265737394" } } } } } }, "400": { "description": "Invalid item not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "400-INVALID-REQUEST" }, "errorDescription": { "type": "string", "example": "Validation Failure" }, "errorList": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "example": "auth" }, "errorCode": { "type": "string", "example": "AUTH-142" }, "errorDescription": { "type": "string", "example": "" }, "errorDetails": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string", "example": "IDGRAPH" }, "errorCode": { "type": "string", "example": "IDG-1235" }, "errorDescription": { "type": "string", "example": "" } } } } } } } } } } }, "examples": { "Item_not_found": { "value": { "error": { "errorCode": "400-INVALID-REQUEST", "errorDescription": "Validation Failure", "errorList": [ { "action": "deleteItemfromCart", "errorCode": "CART-DEL-001", "errorDescription": "INVALID_ITEM_ID_EXCEPTION", "errorDetails": [ { "system": "ShoppingCart", "errorCode": "SC-V40001", "errorDescription": "Provided item doesn't present in the cart" } ] } ] } } } } } } } } } } } }