{ "openapi": "3.0.1", "swagger": "2.0", "info": { "version": "1.0", "title": "2022-08-22_JTV API Gateway_Transformers-Dev" }, "paths": { "/user/{user-id}/agreement": { "get": { "tags": [ "User Agreement" ], "description": "Get user agreements", "operationId": "getUserAgreements", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "user-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The user's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "agreement-action-type", "in": "query", "schema": { "type": "array", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT", "items": { "type": "string", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT" } } } ], "responses": { "200": { "description": "List of agreement pending approval of associate", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserAgreementService_UserAgreementListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserAgreementService_UserAgreementListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/user/{user-id}/agreement-interaction": { "post": { "tags": [ "User Agreement" ], "description": "Create user agreement interaction", "operationId": "createUserAgreementInteraction", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "user-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The user's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserAgreementService_UserAgreementInteractRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserAgreementService_UserAgreementInteractRequest" } } } }, "responses": { "201": { "description": "Create user agreement interaction response", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserAgreementService_CreateAgreementInteractionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserAgreementService_CreateAgreementInteractionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/contact/subscription/marketing/promotional-subscription": { "post": { "tags": [ "Subscriptions" ], "description": "[DONE] Create Promotional Marketing Subscription", "operationId": "promotionalSubscription", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_PromotionalSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_PromotionalSubscriptionRequest" } } } }, "responses": { "201": { "description": "OPT-IN Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_PromotionalSubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_PromotionalSubscriptionResponse" } } } }, "412": { "description": "Already opted in", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/contact/subscription/marketing/game-show": { "post": { "tags": [ "Subscriptions" ], "description": "[DONE] Create Game Show Marketing Subscription", "operationId": "gameShowOptIn", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_GameShowMarketingSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_GameShowMarketingSubscriptionRequest" } } } }, "responses": { "201": { "description": "OPT-IN Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_SubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_SubscriptionResponse" } } } }, "412": { "description": "Already opted in", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/contact/subscription/marketing/promotional": { "post": { "tags": [ "Subscriptions" ], "description": "[DONE] Create Promotional Marketing Subscription", "operationId": "promotionalOptIn", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_PromotionalMarketingSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_PromotionalMarketingSubscriptionRequest" } } } }, "responses": { "201": { "description": "OPT-IN Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_SubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_SubscriptionResponse" } } } }, "412": { "description": "Already opted in", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": true, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/contact/subscription/transactional/back-in-stock": { "post": { "tags": [ "Subscriptions" ], "description": "[DONE] Create Back-In-Stock Subscription", "operationId": "backInStockOptIn", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_BackInStockTransactionalSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_BackInStockTransactionalSubscriptionRequest" } } } }, "responses": { "201": { "description": "OPT-IN Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_SubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ContactService_SubscriptionResponse" } } } }, "412": { "description": "Already opted in", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/country": { "get": { "tags": [ "Country" ], "description": "Get data for all supported countries", "operationId": "getAllAddressCountries", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Country List", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CountryService_GetCountryListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CountryService_GetCountryListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CountryService_GetCountryListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CountryService_GetCountryListResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/country/{country-iso3-code}/stateProvince": { "get": { "tags": [ "Country" ], "description": "Get the stateProvinces for specified country-iso3-code (with stateProvince name query param)", "operationId": "findStateProvincesByCountryCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "country-iso3-code", "in": "path", "description": "ISO 3166-1 alpha-3 country code", "required": true, "schema": { "type": "string" }, "example": "USA" }, { "name": "q", "in": "query", "description": "State/Province type-ahead (prefix) string", "schema": { "type": "string" }, "example": "Mass" } ], "responses": { "200": { "description": "State or Province List", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CountryService_GetStateProvinceListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CountryService_GetStateProvinceListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/curator-product-listings": { "get": { "tags": [ "Curator Product Listings" ], "description": "Get Curator Product Listings", "operationId": "getCuratorProductListings", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "start-index", "in": "query", "description": "The starting index of the paged result set. default = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "page-size", "in": "query", "description": "The page size paged result. default = 25 min = 1, max = 99 ", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 1 }, { "name": "listing-status-classification", "in": "query", "description": "The listing status classification: all, active, inactive", "schema": { "type": "string", "enum": [ "ALL", "ACTIVE", "INACTIVE" ] }, "example": "active" }, { "name": "listing-status-code", "in": "query", "description": "A collection of listing status codes filter", "schema": { "maxItems": 20, "minItems": 0, "type": "array", "items": { "type": "string" } }, "example": "ACTIVE" }, { "name": "product-type", "in": "query", "description": "A collection of listing product types filter", "schema": { "maxItems": 20, "minItems": 0, "type": "array", "items": { "type": "string" } }, "example": "Ring" }, { "name": "look-style-rate-code", "in": "query", "description": "A collection of listing's look style rate codes filter", "schema": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "type": "string" } }, "example": "10_PERCENT" }, { "name": "assort-style-rate-code", "in": "query", "description": "A collection of listing's assortment style rate codes filter", "schema": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "type": "string" } }, "example": "10_PERCENT" }, { "name": "star-rating", "in": "query", "description": "A collection of listing's star ratings filter: 1, 2, 3, 4, 5", "schema": { "maxItems": 5, "minItems": 0, "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": 2 }, { "name": "shop-profile-id", "in": "query", "description": "The listing's shop profile id", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "exclude-style-listing-id", "in": "query", "description": "The style listing id to exclude", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "exclude-list-header-id", "in": "query", "description": "The list header id to exclude", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "exclude-look-header-id", "in": "query", "description": "The look header id to exclude", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "exclude-assort-header-id", "in": "query", "description": "The assortment header id to exclude", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-listing-id", "in": "query", "description": "The style listing id filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "list-header-id", "in": "query", "description": "The listing header id filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "look-header-id", "in": "query", "description": "The look header id filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "assort-header-id", "in": "query", "description": "The assortment header id filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "keyword-search", "in": "query", "description": "The keywork search terms filter", "schema": { "type": "string" }, "example": "blue topaz" }, { "name": "listing-eligibility", "in": "query", "description": "The listing eligibility filter: look, assortment, or list", "schema": { "type": "string" }, "example": "look" }, { "name": "partner-id", "in": "query", "description": "The listing partner id filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "alternate-look-line-id", "in": "query", "description": "The parent look line id of the alternate filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "exclude-alternate-look-line-id", "in": "query", "description": "The exclude parent look line id of the alternate filter", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Curator Product Listings", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CuratorProductListings_GetCuratorProductListingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CuratorProductListings_GetCuratorProductListingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}/address": { "get": { "tags": [ "Customer" ], "description": "[DONE] Get enterprise customer address list", "operationId": "getCustomerAddressList", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Customer Addresses", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerAddressesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerAddressesResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Customer Addresses Do Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer" ], "description": "[DONE] Create enterprise customer address for an authenticated customer", "operationId": "createCustomerAddress", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerAddressRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerAddressRequest" } } } }, "responses": { "201": { "description": "Address Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerAddressResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerAddressResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Customer Does Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}/address/{address-id}": { "get": { "tags": [ "Customer" ], "description": "[DONE] Get enterprise customer address", "operationId": "getCustomerAddress", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "address-id", "in": "path", "description": "The enterprise customer address identifier.", "required": true, "schema": { "type": "string" }, "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } ], "responses": { "200": { "description": "Customer Address", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerAddressResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerAddressResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Customer Address Does Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Customer" ], "description": "[DONE] Mark as inactive an enterprise customer address for an authenticated customer", "operationId": "deleteCustomerAddress", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "address-id", "in": "path", "description": "The enterprise customer address identifier.", "required": true, "schema": { "type": "string" }, "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } ], "responses": { "200": { "description": "Address Deleted Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_DeleteCustomerAddressResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_DeleteCustomerAddressResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Address Does Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}/purchase-defaults": { "get": { "tags": [ "Customer Defaults" ], "description": "[DONE] Get a list of customer purchase defaults", "operationId": "getCustomerDefaults", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Customer Sales Channel Purchase Defaults", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerPurchaseDefaults" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerPurchaseDefaults" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}/purchase-defaults/{channel}": { "get": { "tags": [ "Customer Defaults" ], "description": "[DONE] Get customer purchase defaults for a given sales channel", "operationId": "getCustomerDefaultsForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "responses": { "200": { "description": "Customer Purchase Defaults For Given Sales Channel", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerSalesChannelPurchaseDefaults" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerSalesChannelPurchaseDefaults" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer Defaults" ], "description": "[DONE] Merge customer purchase defaults for a given sales channel", "operationId": "mergeCustomerDefaultsForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "requestBody": { "description": "The purchase defaults for the given sales channel", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeSalesChannelDefaults" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeSalesChannelDefaults" } } }, "required": true }, "responses": { "200": { "description": "Merged", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Customer Defaults" ], "description": "[DONE] Delete customer purchase defaults for a given sales channel", "operationId": "deleteCustomerDefaultsForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "responses": { "200": { "description": "Deleted", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}/purchase-defaults/{channel}/address": { "get": { "tags": [ "Customer Defaults" ], "description": "[DONE] Get customer purchase default address for a given sales channel", "operationId": "getCustomerDefaultAddressForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "responses": { "200": { "description": "Customer Purchase Defaults For Given Sales Channel", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerSalesChannelPurchaseDefaults" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerSalesChannelPurchaseDefaults" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer Defaults" ], "description": "[DONE] Merge customer purchase default addressId for a given sales channel", "operationId": "mergeCustomerDefaultAddressForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "requestBody": { "description": "The purchase default address for the given sales channel", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeSalesChannelDefaultAddress" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeSalesChannelDefaultAddress" } } }, "required": true }, "responses": { "200": { "description": "Merged", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Customer Defaults" ], "description": "[DONE] Delete customer purchase default addressId for a given sales channel", "operationId": "deleteCustomerDefaultAddressForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "responses": { "200": { "description": "Deleted", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}/purchase-defaults/{channel}/payment-account": { "get": { "tags": [ "Customer Defaults" ], "description": "[DONE] Get customer purchase default payment account for a given sales channel", "operationId": "getCustomerDefaultMopForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "responses": { "200": { "description": "Customer Purchase Defaults For Given Sales Channel Code", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerSalesChannelPurchaseDefaults" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CustomerSalesChannelPurchaseDefaults" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer Defaults" ], "description": "[DONE] Merge customer purchase default payment account for a given sales channel", "operationId": "mergeCustomerDefaultMopForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "requestBody": { "description": "The purchase default payment account for the given sales channel", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeSalesChannelDefaultPaymentAccount" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeSalesChannelDefaultPaymentAccount" } } }, "required": true }, "responses": { "200": { "description": "Merged", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Customer Defaults" ], "description": "[DONE] Delete customer purchase default payment account for a given sales channel", "operationId": "deleteCustomerDefaultMopForSalesChannel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "channel", "in": "path", "description": "The JTV Sales Channel Code [jtv-call-center,jtv-online,jtv-auction,jtv-eos]", "required": true, "schema": { "type": "string" }, "example": "auction" } ], "responses": { "200": { "description": "Deleted", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_MergeCustomerDefaultsResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer/{customer-id}": { "get": { "tags": [ "Customer" ], "description": "[DONE] Get enterprise customer profile for an authenticated customer.", "operationId": "getCustomerProfile", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Customer Profile Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerProfileResponse" } } } }, "403": { "description": "Customer is forbidden to access this data", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The customer profile does not exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer" ], "description": "[DONE] Update enterprise customer profile for an authenticated customer", "operationId": "updateCustomerProfile", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "path", "description": "The unique customer identifier", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_UpdateCustomerProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_UpdateCustomerProfileRequest" } } } }, "responses": { "200": { "description": "Profile Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_UpdateCustomerProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_UpdateCustomerProfileResponse" } } } }, "404": { "description": "Profile Does Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer": { "get": { "tags": [ "Customer" ], "description": "[DONE] Get enterprise customer profile list for the identity provider UUID in a query parameter.", "operationId": "getCustomerProfileList", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "idp-uuid", "in": "query", "description": "A well formed UUID. Example [183f9087-dd8c-5184-d1e6-6c47bfb6b312]", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Customer Profile List", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerProfileListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_GetCustomerProfileListResponse" } } } }, "403": { "description": "Customer is forbidden to access this data", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer" ], "description": "[DONE] Create enterprise customer profile", "operationId": "createCustomerProfile", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerProfileRequest" } } } }, "responses": { "201": { "description": "Profile Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerProfileResponse" } } } }, "409": { "description": "Profile Already Exists", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer-referral-code": { "get": { "tags": [ "Customer Referral" ], "description": "[Done] Get Referral Code", "operationId": "getReferralCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } ], "responses": { "200": { "description": "Referral Code", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_GetReferralCodeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_GetReferralCodeResponse" } } } }, "400": { "description": "No customer id present", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer Referral" ], "description": "[DONE] Create Referral Code", "operationId": "createReferralCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeRequest" } } } }, "responses": { "201": { "description": "Created Referral Code", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeResponse" } } } }, "404": { "description": "The customer profile does not exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The customer referral code already exists", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Customer Referral" ], "description": "[Done] Deactivate Referral Code", "operationId": "deactivateReferralCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_DeleteReferralCodeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_DeleteReferralCodeResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer-referral-code/{referral-code}": { "get": { "tags": [ "Customer Referral" ], "description": "[Done] Get Referral Code", "operationId": "getReferralCodeByReferralCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "referral-code", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique referral code.", "example": "W9348M11LD" } } ], "responses": { "200": { "description": "Referral Code", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_GetReferralCodeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_GetReferralCodeResponse" } } } }, "400": { "description": "No customer id present", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Customer Referral" ], "description": "[DONE] Create Referral Code", "operationId": "createSpecificReferralCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "referral-code", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique referral code.", "example": "W9348M11LD" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeRequest" } } } }, "responses": { "201": { "description": "Created Referral Code", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_CreateReferralCodeResponse" } } } }, "404": { "description": "The customer profile does not exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The customer referral code already exists", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Customer Referral" ], "description": "[Done] Deactivate Referral Code", "operationId": "deactivateSpecificReferralCode", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "referral-code", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique referral code.", "example": "W9348M11LD" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_DeleteReferralCodeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralCodeService_DeleteReferralCodeResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/customer-referral-validation": { "post": { "tags": [ "Customer Referral" ], "description": "[Done] Validate Customer Referral", "operationId": "validateCustomerReferral", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralValidationService_ValidateCustomerReferralRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralValidationService_ValidateCustomerReferralRequest" } } } }, "responses": { "200": { "description": "Customer Referral Validated", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralValidationService_ValidateCustomerReferralResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CustomerReferralValidationService_ValidateCustomerReferralResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/installment-billing": { "get": { "tags": [ "Installment Billing" ], "description": "[WIP] Get the customer's installment billing summary", "operationId": "getInstallmentBillingSummary", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingSummaryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingSummaryResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/installment-billing/active-plan": { "get": { "tags": [ "Installment Billing" ], "description": "[WIP] Get the customer's installment billing active plans", "operationId": "getInstallmentBillingActivePlans", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 50", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting record index of the paged result set.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "start-date", "in": "query", "description": "The earliest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-01-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "end-date", "in": "query", "description": "The latest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-12-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "plan-filter", "in": "query", "description": "The installment billing plan filter", "schema": { "type": "string", "enum": [ "ACTIVE", "ACTIVE_DELINQUENT", "ACTIVE_CURRENT" ], "default": "ACTIVE_CURRENT" }, "example": "ACTIVE_CURRENT" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlansResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlansResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/installment-billing/inactive-plan": { "get": { "tags": [ "Installment Billing" ], "description": "[WIP] Get the customer's installment billing inactive plans", "operationId": "getInstallmentBillingInactivePlans", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 50", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting record index of the paged result set.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "start-date", "in": "query", "description": "The earliest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-01-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "end-date", "in": "query", "description": "The latest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-12-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "plan-filter", "in": "query", "description": "The installment billing plan filter", "schema": { "type": "string", "enum": [ "ACTIVE", "ACTIVE_DELINQUENT", "ACTIVE_CURRENT" ], "default": "ACTIVE_CURRENT" }, "example": "ACTIVE_CURRENT" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlansResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlansResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/installment-billing/active-line": { "get": { "tags": [ "Installment Billing" ], "description": "Get the customer's installment billing active billing lines", "operationId": "getInstallmentBillingActiveBillingLines", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 50", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting record index of the paged result set.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "start-date", "in": "query", "description": "The earliest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-01-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "end-date", "in": "query", "description": "The latest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-12-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "plan-filter", "in": "query", "description": "The installment billing plan filter", "schema": { "type": "string", "enum": [ "ACTIVE", "ACTIVE_DELINQUENT", "ACTIVE_CURRENT" ], "default": "ACTIVE_CURRENT" }, "example": "ACTIVE_CURRENT" }, { "name": "payment-method-id", "in": "query", "schema": { "type": "string", "description": "A well formed UUID. Example [183f9087-dd8c-5184-d1e6-6c47bfb6b312]", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "payment-state-filter", "in": "query", "description": "The installment billing payment state filter", "schema": { "type": "string", "enum": [ "DISABLED", "ACTIONABLE", "NOT_ACTIONABLE", "NEW", "AUTHORIZED", "DECLINED", "AUTHORIZING", "FAILED", "SETTLED" ], "default": "DISABLED" }, "example": "DISABLED" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLinesResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/installment-billing/inactive-line": { "get": { "tags": [ "Installment Billing" ], "description": "[WIP] Get the customer's installment billing inactive billing lines", "operationId": "getInstallmentBillingInactiveBillingLines", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 50", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting record index of the paged result set.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "start-date", "in": "query", "description": "The earliest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-01-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "end-date", "in": "query", "description": "The latest installment-due-date to consider for the installment billing search. Defaults to null.", "example": "2017-12-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLinesResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/installment-billing-validation/order-validation": { "post": { "tags": [ "Installment Billing" ], "description": "Validate Installment Billing Order", "operationId": "validateInstallmentBillingCustomerOrder", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingValidationService_InstallmentBillingOrderValidationRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingValidationService_InstallmentBillingOrderValidationRequest" } } } }, "responses": { "200": { "description": "Installment Billing Order Validated", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingValidationService_InstallmentBillingOrderValidationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InstallmentBillingValidationService_InstallmentBillingOrderValidationResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/{order-id}/line-item/{order-line-item-id}/cancellation": { "post": { "tags": [ "Order" ], "description": "[WIP] Perform a cancellation of an order line item. This is an idempotent operation.", "operationId": "cancelOrderLineItem", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "order-id", "in": "path", "description": "The enterprise order identifier", "required": true, "schema": { "type": "string" }, "example": 654321 }, { "name": "order-line-item-id", "in": "path", "description": "The enterprise order line item identifier", "required": true, "schema": { "type": "string" }, "example": 654322 } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCancelService_CancellationRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCancelService_CancellationRequest" } } } }, "responses": { "200": { "description": "Cancellation Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCancelService_CancellationResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Order or line item does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Customer does not own this order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/cancellation-reason": { "get": { "tags": [ "Order" ], "description": "[DONE] Get Order Cancellation Reasons", "operationId": "getCancellationReasons", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Order Cancellation Reasons Response", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCancelService_CancellationReasonResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCancelService_CancellationReasonResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order": { "get": { "tags": [ "Order" ], "description": "[DONE] Get list of customer's order header information", "operationId": "getCustomerOrderHeaderList", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 50", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting record index of the paged result set.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "start-date", "in": "query", "description": "The earliest date to consider for the customer history search. Earliest (default) is January 01 2007. The max difference between start date and end date is 365 days", "example": "2016-03-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "end-date", "in": "query", "description": "The latest date to consider for the customer history search. Defaults to today.", "example": "2016-04-01T00:00:00.000-05:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "plan-state", "in": "query", "description": "The installment billing plan state [ALL,ACTIVE,CURRENT,DELINQUENT,INACTIVE]. If provided the API will only return installment billing orders that match the given plan-state.", "example": "ACTIVE", "content": { "application/json; charset=utf-8": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/xml; charset=utf-8": { "schema": { "type": "array", "items": { "type": "string" } } } } }, { "name": "line-item-status", "in": "query", "description": "The line item status [WAITING_TO_SHIP,HOLD,READY_TO_PROCESS,DECLINES,CANCELLED,UNKNOWN,ZERO_QTY,NO_FUNDS,SHIPPED] .", "example": "Shipped", "content": { "application/json; charset=utf-8": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "WAITING_TO_SHIP", "HOLD", "READY_TO_PROCESS", "DECLINES", "CANCELLED", "UNKNOWN", "ZERO_QTY", "NO_FUNDS", "SHIPPED", "EMPLOYEE" ] } } }, "application/xml; charset=utf-8": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "WAITING_TO_SHIP", "HOLD", "READY_TO_PROCESS", "DECLINES", "CANCELLED", "UNKNOWN", "ZERO_QTY", "NO_FUNDS", "SHIPPED", "EMPLOYEE" ] } } } } } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderHeaderResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Order" ], "description": "[WIP] Create Order", "operationId": "createOrder", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCreationService_OrderCreationRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCreationService_OrderCreationRequest" } } } }, "responses": { "201": { "description": "Order Created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCreationService_OrderCreationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderCreationService_OrderCreationResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/{order-id}/order-line-item": { "get": { "tags": [ "Order" ], "description": "[DONE] Get customer order header and ALL line-item details for the given order id", "operationId": "getCustomerOrderDetail", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "order-id", "in": "path", "description": "The target details order id.", "required": true, "schema": { "type": "string" }, "example": 108841856 }, { "name": "include-tracking", "in": "query", "description": "Include package tracking information", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "line-item-status", "in": "query", "description": "The line item status [WAITING_TO_SHIP,HOLD,READY_TO_PROCESS,DECLINES,CANCELLED,UNKNOWN,ZERO_QTY,NO_FUNDS,SHIPPED]", "example": "Shipped", "content": { "application/json; charset=utf-8": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "WAITING_TO_SHIP", "HOLD", "READY_TO_PROCESS", "DECLINES", "CANCELLED", "UNKNOWN", "ZERO_QTY", "NO_FUNDS", "SHIPPED", "EMPLOYEE" ] } } }, "application/xml; charset=utf-8": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "WAITING_TO_SHIP", "HOLD", "READY_TO_PROCESS", "DECLINES", "CANCELLED", "UNKNOWN", "ZERO_QTY", "NO_FUNDS", "SHIPPED", "EMPLOYEE" ] } } } } } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderDetailResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/{order-id}": { "get": { "tags": [ "Order" ], "description": "[DONE] Get customer order header information for specific order", "operationId": "getCustomerOrderHeader", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "order-id", "in": "path", "description": "The enterprise order id.", "required": true, "schema": { "type": "string" }, "example": 108841856 } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderHeaderResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/gemstones": { "get": { "tags": [ "Order" ], "description": "[DONE] Get list of customer's gemstone orders", "operationId": "getCustomerGemstoneOrders", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "start-date", "in": "query", "description": "The earliest date to consider for the customer history", "schema": { "$ref": "#/components/schemas/DeprecatedDateType" }, "example": "2016-03-01T00:00:00.000-0500" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "schema": { "$ref": "#/components/schemas/DeprecatedDateType" }, "example": "2001-07-04T12:08:56.235-0700" }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderDetailResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/{order-id}/order-line-item/{order-line-item-id}": { "get": { "tags": [ "Order" ], "description": "[WIP] Get customer order header and ONE specific line-item details for the given order line item id", "operationId": "getCustomerLineItemDetail", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "customer-id", "in": "query", "description": "The unique customer identifier", "schema": { "type": "string" }, "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, { "name": "order-id", "in": "path", "description": "The target details order id.", "required": true, "schema": { "type": "string" }, "example": 108841856 }, { "name": "order-line-item-id", "in": "path", "description": "The target details order line item id.", "required": true, "schema": { "type": "string" }, "example": 108841856 }, { "name": "include-tracking", "in": "query", "description": "Include package tracking information", "schema": { "type": "boolean", "default": false }, "example": false } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderLineItemDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderLineItemDetailResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/webguest-order-history/{order-id}": { "get": { "tags": [ "Order" ], "description": "[DONE] Get webguest order detail", "operationId": "getWebguestOrderDetail", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "email-address", "in": "query", "description": "The email address associated with the order.", "schema": { "type": "string" }, "example": "susan.smith@gmail.com" }, { "name": "phone-number", "in": "query", "description": "The phone number associated with the order.", "schema": { "type": "string" }, "example": 1530640809 }, { "name": "order-id", "in": "path", "description": "The target details order id.", "required": true, "schema": { "type": "string" }, "example": 115931919 }, { "name": "include-tracking", "in": "query", "description": "Include package tracking information", "schema": { "type": "boolean", "default": false }, "example": false } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderHistoryService_GetCustomerOrderDetailResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/{order-id}/line-item/{order-line-item-id}/return-label": { "get": { "tags": [ "Order" ], "description": "[WIP] Get Line Item Return Label. Note, not all orders have return labels.", "operationId": "getOrderReturnLabel", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "order-id", "in": "path", "description": "The order identifier", "required": true, "schema": { "type": "string" }, "example": 654321 }, { "name": "order-line-item-id", "in": "path", "description": "The order line item identifier", "required": true, "schema": { "type": "string" }, "example": 654322 } ], "responses": { "200": { "description": "The Return Label PDF" }, "404": { "description": "The resource does not exist", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/order/{order-id}/line-item/{order-line-item-id}/return-label/email": { "post": { "tags": [ "Order" ], "description": "[WIP] Create an Order Line Item Return Label and Send via e-Mail of Adresss on File. Note, not all orders have return labels.", "operationId": "sendOrderReturnLabelViaEmail", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "order-id", "in": "path", "description": "The order identifier", "required": true, "schema": { "type": "string" }, "example": 654321 }, { "name": "order-line-item-id", "in": "path", "description": "The order line item identifier", "required": true, "schema": { "type": "string" }, "example": 654322 } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderReturnLabelService_OrderReturnLabelEmailRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderReturnLabelService_OrderReturnLabelEmailRequest" } } } }, "responses": { "200": { "description": "Return Label Creation Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderReturnLabelService_OrderReturnLabelEmailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/OrderReturnLabelService_OrderReturnLabelEmailResponse" } } } }, "404": { "description": "The resource does not exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/agreement": { "get": { "tags": [ "Partner Agreement" ], "description": "Get partner agreements", "operationId": "getPartnerAgreements", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "agreement-action-type", "in": "query", "schema": { "type": "array", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT", "items": { "type": "string", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT" } } }, { "name": "service-offer-code", "in": "query", "schema": { "type": "array", "description": "The agreement related service offer code [JTV_CONSIGNMENT,JTV_INBOUND_FREIGHT, ...etc]. If provided the API will only return partner agreements related to service offer code.", "example": "JTV_CONSIGNMENT", "items": { "type": "string", "description": "The agreement related service offer code [JTV_CONSIGNMENT,JTV_INBOUND_FREIGHT, ...etc]. If provided the API will only return partner agreements related to service offer code.", "example": "JTV_CONSIGNMENT" } } } ], "responses": { "200": { "description": "Partner Agreement List", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/agreement-interaction": { "post": { "tags": [ "Partner Agreement" ], "description": "Create partner agreement interaction", "operationId": "createPartnerAgreementInteraction", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementInteractRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementInteractRequest" } } } }, "responses": { "201": { "description": "Create agreement interaction response", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_CreateAgreementInteractionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_CreateAgreementInteractionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/order-header/{order-header-id}/agreement": { "get": { "tags": [ "Partner Agreement" ], "description": "Get agreements for order", "operationId": "getPartnerOrderAgreements", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "agreement-action-type", "in": "query", "schema": { "type": "array", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT", "items": { "type": "string", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT" } } } ], "responses": { "200": { "description": "Partner Agreement List", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/order-header/{order-header-id}/agreement-interaction": { "post": { "tags": [ "Partner Agreement" ], "description": "Create partner order agreement interaction", "operationId": "createPartnerOrderAgreementInteraction", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "agreement-action-type", "in": "query", "schema": { "type": "array", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT", "items": { "type": "string", "description": "The agreement action type [NO_ACTION,SEND_EMAIL, USER_CLICKWRAP_CONSENT]. If provided the API will only return partner agreements that have given action type.", "example": "USER_CLICKWRAP_CONSENT" } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementInteractRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreementInteractRequest" } } } }, "responses": { "201": { "description": "Create agreement interaction response", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_CreateAgreementInteractionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAgreementService_CreateAgreementInteractionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/associate": { "get": { "tags": [ "Partner Associate" ], "description": "Get partner associates list for a partner.", "operationId": "getPartnerAssociates", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-filter", "in": "query", "description": "The partner associate filter", "schema": { "type": "string", "enum": [ "ALL", "ME" ], "default": "ALL" }, "example": "ALL" }, { "name": "page-size", "in": "query", "description": "The page size of partner associates. Max = 100.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 15 }, { "name": "start-index", "in": "query", "description": "The starting index of associates from the ordered set. Min = 1.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 10 } ], "responses": { "200": { "description": "Partner Associates", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_GetPartnerAssociatesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_GetPartnerAssociatesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Partner Associate" ], "description": "Create enterprise partner associate", "operationId": "createPartnerAssociate", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_CreatePartnerAssociateRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_CreatePartnerAssociateRequest" } } } }, "responses": { "201": { "description": "Associate Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_CreatePartnerAssociateResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_CreatePartnerAssociateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/associate/{associate-id}": { "get": { "tags": [ "Partner Associate" ], "description": "Get enterprise partner associate for an authenticated user.", "operationId": "getPartnerAssociate", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Associate Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_GetPartnerAssociateResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_GetPartnerAssociateResponse" } } } }, "401": { "description": "Unable to authenticate using the Authorization header", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "User is forbidden to access this data", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The partner associate does not exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Partner Associate" ], "description": "Update partner associate", "operationId": "updatePartnerAssociate", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_UpdatePartnerAssociateRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_UpdatePartnerAssociateRequest" } } } }, "responses": { "200": { "description": "Partner Associate Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_UpdatePartnerAssociateResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_UpdatePartnerAssociateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Partner Associate" ], "description": "Deactivate partner associate from partner", "operationId": "deletePartnerAssociate", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Associate deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_DeletePartnerAssociateResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateService_DeletePartnerAssociateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/associate/{associate-id}/invite": { "post": { "tags": [ "Partner Associate" ], "description": "Invite partner associate", "operationId": "invitePartnerAssociate", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Associate Invited Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateInviteService_InvitePartnerAssociateResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateInviteService_InvitePartnerAssociateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Partner Associate" ], "description": "Cancel partner associate invitations", "operationId": "deletePartnerAssociateInvites", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Associate Invitations cancelled successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateInviteService_CancelPartnerAssociateInvitesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociateInviteService_CancelPartnerAssociateInvitesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/associate/{associate-id}/permission": { "get": { "tags": [ "Partner Associate" ], "description": "Get permissions for partner associate.", "operationId": "getPartnerAssociatePermissions", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "permission-filter", "in": "query", "description": "The partner associate permission filter", "schema": { "type": "string", "enum": [ "ALL", "ASSIGNED" ], "default": "ALL" }, "example": "ALL" } ], "responses": { "200": { "description": "Partner Associate Permissions", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_GetPartnerAssociatePermissionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_GetPartnerAssociatePermissionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Partner Associate" ], "description": "Set permission for a partner associate", "operationId": "setPartnerAssociatePermission", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_CreatePartnerAssociatePermissionAssignmentRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_CreatePartnerAssociatePermissionAssignmentRequest" } } } }, "responses": { "201": { "description": "Permissions Set Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_CreatePartnerAssociatePermissionAssignmentResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_CreatePartnerAssociatePermissionAssignmentResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Partner Associate or Permission Does Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/associate/{associate-id}/permission/{permission-assignment-id}": { "delete": { "tags": [ "Partner Associate" ], "description": "Delete permission for a partner associate", "operationId": "deletePartnerAssociatePermission", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "associate-id", "in": "path", "description": "The partner associate's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "permission-assignment-id", "in": "path", "description": "The unique identifier for the associate permission assignment.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "201": { "description": "Permissions Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_DeletePartnerAssociatePermissionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_DeletePartnerAssociatePermissionResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Partner Associate or Permission Does Not Exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Permission conflicts with permission already assigned for the same feature code. Delete the existing assignment and then retry the operation.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import": { "get": { "tags": [ "Partner Bulk Import" ], "description": "Get partner bulk import header list.", "operationId": "getBulkImportHeaderList", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 100", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "start-index", "in": "query", "description": "The starting index from which to pull header list from headers table. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "import-header-type-code-list", "in": "query", "description": "The list of Import Header Types to filter the list of Import Headers.", "schema": { "type": "array", "items": { "type": "string" } }, "example": "DROP_SHIP_INVENTORY" }, { "name": "import-header-status-code-list", "in": "query", "description": "The list of Import Header Statuses to filter the list of Import Headers.", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_DATA" }, { "name": "start-date", "in": "query", "description": "The start date of the Custom Date Range of created on dates to filter the list of Import Headers", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "end-date", "in": "query", "description": "The end date of the Custom Date Range of created on dates to filter the list of Import Headers", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "import-standard-date-range-code", "in": "query", "description": "The code for the Standard Date Range of created on dates to filter the list of Import Headers", "schema": { "type": "string", "description": "The Standard Date Range code", "enum": [ "TODAY", "YESTERDAY", "PAST_7_DAYS", "PAST_30_DAYS", "PAST_60_DAYS", "PAST_3_MONTHS", "PAST_6_MONTHS", "PAST_YEAR", "TODAY", "YESTERDAY", "PAST_7_DAYS", "PAST_30_DAYS", "PAST_60_DAYS", "PAST_3_MONTHS", "PAST_6_MONTHS", "PAST_YEAR" ] }, "example": "TODAY" }, { "name": "import-header-id", "in": "query", "description": "The import header id filter query parameter ( uuid )", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Available partner bulk import header list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetListOfBulkImportHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetListOfBulkImportHeadersResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Partner Bulk Import" ], "description": "Create enterprise partner bulk import header.", "operationId": "createPartnerBulkImportHeader", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportHeaderRequest" } } } }, "responses": { "201": { "description": "Bulk Import Header Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportHeaderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/{import-header-id}/upload-uri": { "post": { "tags": [ "Partner Bulk Import" ], "description": "Create a signed upload URI for a bulk import.", "operationId": "createPartnerBulkImportAssetUploadUri", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "import-header-id", "in": "path", "description": "The partner bulk import's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportAssetUploadUriRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportAssetUploadUriRequest" } } } }, "responses": { "201": { "description": "Partner Bulk Import Upload URI created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportAssetUploadUriResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CreateBulkImportAssetUploadUriResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/{import-header-id}": { "get": { "tags": [ "Partner Bulk Import" ], "description": "Get details for a partner bulk import header .", "operationId": "getBulkImportHeaderDetail", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "import-header-id", "in": "path", "description": "The partner bulk import's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Details for a partner bulk import header", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetBulkImportHeaderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetBulkImportHeaderDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "post": { "tags": [ "Partner Bulk Import" ], "description": "Update partner bulk import header.", "operationId": "updatePartnerBulkImportHeader", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "import-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The bulk import header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_UpdateBulkImportHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_UpdateBulkImportHeaderRequest" } } } }, "responses": { "200": { "description": "Bulk Import Header Update Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_UpdateBulkImportHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_UpdateBulkImportHeaderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] }, "delete": { "tags": [ "Partner Bulk Import" ], "description": "Cancel enterprise partner bulk import header.", "operationId": "cancelPartnerBulkImportHeader", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "import-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The bulk import header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Bulk Import Header Canceled Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CancelBulkImportHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_CancelBulkImportHeaderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/bulk-inventory-auto-config-by-partner-uuid": { "get": { "tags": [ "Partner Bulk Import" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "getBulkInventoryAutoConfigByPartnerUuid", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "201": { "description": "Fetched Bulkinventory auto config Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetBulkInventoryAutoConfigByPartnerUuidResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetBulkInventoryAutoConfigByPartnerUuidResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/getBulkInventoryAutoConfigByPartnerUuid": { "get": { "tags": [ "Partner Bulk Import" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "getBulkInventoryAutoConfigByPartnerUuidDeprecated", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "201": { "description": "Fetched Bulkinventory auto config Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetBulkInventoryAutoConfigByPartnerUuidResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_GetBulkInventoryAutoConfigByPartnerUuidResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": true, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/bulk-inventory-auto-config-reset-password-email": { "post": { "tags": [ "Partner Bulk Import" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "sendBulkInventoryAutoConfigResetPasswordEmail", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "201": { "description": "Bulk Inventory Auto Config Persisted Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SendBulkInventoryAutoConfigResetPasswordEmailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SendBulkInventoryAutoConfigResetPasswordEmailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/bulk-inventory-auto-config": { "post": { "tags": [ "Partner Bulk Import" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "saveBulkInventoryAutoConfig", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SaveBulkInventoryAutoConfigRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SaveBulkInventoryAutoConfigRequest" } } } }, "responses": { "201": { "description": "Bulk Inventory Auto Config Persisted Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoConfigResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoConfigResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/sendBulkInventoryAutoConfigResetPasswordEmail": { "post": { "tags": [ "Partner Bulk Import" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "sendBulkInventoryAutoConfigResetPasswordEmailDeprecated", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "201": { "description": "Bulk Inventory Auto Config Persisted Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SendBulkInventoryAutoConfigResetPasswordEmailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SendBulkInventoryAutoConfigResetPasswordEmailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": true, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner/{partner-id}/bulk-import/saveBulkInventoryAutoConfig": { "post": { "tags": [ "Partner Bulk Import" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "saveBulkInventoryAutoConfigDeprecated", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "partner-id", "in": "path", "description": "The partner's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SaveBulkInventoryAutoConfigRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SaveBulkInventoryAutoConfigRequest" } } } }, "responses": { "201": { "description": "Bulk Inventory Auto Config Persisted Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoConfigResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoConfigResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "The request could not be completed due to a data conflict.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "deprecated": true, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/user-profile-roles": { "get": { "tags": [ "Partner Common" ], "description": "Get user profile specializations.", "operationId": "getRoles", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Available user profile roles", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetRoleResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetRoleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/shop-profile-label": { "get": { "tags": [ "Partner Common" ], "description": "Get available shop profile labels.", "operationId": "getShopProfileLabels", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" } ], "responses": { "200": { "description": "Available shop profile labels", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileLabelsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileLabelsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/shop-profile-category": { "get": { "tags": [ "Partner Common" ], "description": "Get available shop profile categories.", "operationId": "getShopProfileCategories", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" } ], "responses": { "200": { "description": "Available shop profile categories", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileCategoriesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileCategoriesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/shop-profile-external-link-type": { "get": { "tags": [ "Partner Common" ], "description": "Get available shop profile external link types.", "operationId": "getShopProfileExternalLinkTypes", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" } ], "responses": { "200": { "description": "Available shop profile external link types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileExternalLinkTypesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileExternalLinkTypesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/packaging-type": { "get": { "tags": [ "Partner Common" ], "description": "Get available packaging types.", "operationId": "getPackagingTypes", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "packaging-brand-code", "in": "query", "description": "The packaging brand code", "schema": { "type": "string", "enum": [ "UPS", "USPS", "CUSTOM", "FEDEX" ] }, "example": "USPS" }, { "name": "carrier-code", "in": "query", "description": "The package brand code", "schema": { "type": "string", "enum": [ "USPS", "UPS", "FEDEX", "DHL", "DROP_OFF", "OTHER" ] }, "example": "USPS" }, { "name": "packaging-use-type", "in": "query", "description": "The packaging use type", "schema": { "type": "string", "enum": [ "REPLENISHMENT", "FULFILLMENT" ], "default": "REPLENISHMENT" }, "example": "REPLENISHMENT" } ], "responses": { "200": { "description": "Available packaging types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetPackagingTypesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetPackagingTypesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/bank-transfer-config": { "get": { "tags": [ "Partner Common" ], "description": "Get available bank transfer country configuration list.", "operationId": "getBankTransferCountryConfigs", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 100", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting index from which to pull listings from the ordered set. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 }, { "name": "countryCode", "in": "query", "description": "The countryIso3Code from which to filter listings from the ordered set.", "schema": { "type": "string" }, "example": "USA" } ], "responses": { "200": { "description": "Available bank transfer country configuration list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBankTransferCountryConfigsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBankTransferCountryConfigsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/transaction-classification-options": { "get": { "tags": [ "Partner Common" ], "description": "Get financial transaction classification options.", "operationId": "getFinancialTransactionClassificationOptions", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Available financial transaction classification options", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFinancialTransactionClassificationOptionsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFinancialTransactionClassificationOptionsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/package-state": { "patch": { "tags": [ "Partner Common" ], "description": "Update package state", "operationId": "updatePackageState", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_UpdatePackageStateRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_UpdatePackageStateRequest" } } } }, "responses": { "201": { "description": "Package states are updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_UpdatePackageStateResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_UpdatePackageStateResponse" } } } }, "403": { "description": "Operation is forbidden", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Package ID does not exist", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/shop-profile-return-periods": { "get": { "tags": [ "Partner Common" ], "description": "Get shop profile policy return periods.", "operationId": "getShopProfilePolicyReturnPeriods", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" } ], "responses": { "200": { "description": "Available shop profile policy return periods", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileReturnPeriodResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetShopProfileReturnPeriodResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/user-profile-external-link-type": { "get": { "tags": [ "Partner Common" ], "description": "Get available user profile external link types.", "operationId": "getUserProfileExternalLinkTypes", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" } ], "responses": { "200": { "description": "Available user profile external link types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetUserProfileExternalLinkTypesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetUserProfileExternalLinkTypesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/hyperwallet-notification-event": { "post": { "tags": [ "Partner Common" ], "description": "Create hyperwallet webhook notification", "operationId": "createHyperwalletWebhookNotification", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_CreateHyperwalletWebhookNotificationRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_CreateHyperwalletWebhookNotificationRequest" } } } }, "responses": { "200": { "description": "Created hyperwallet webhook notification", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_CreateHyperwalletWebhookNotificationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_CreateHyperwalletWebhookNotificationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/fulfillment-delivery-service-order-status": { "get": { "tags": [ "Partner Common" ], "description": "Get the list of drop ship delivery service order statuses.", "operationId": "getFulfillmentOrderStatuses", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Drop ship delivery service order status list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/fulfillment-delivery-service-order-status-class": { "get": { "tags": [ "Partner Common" ], "description": "Get the list of drop ship delivery service order status classes.", "operationId": "getFulfillmentOrderStatusClasses", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Drop ship delivery service order status class list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderStatusClassResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderStatusClassResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/fulfillment-delivery-service-order-line-status": { "get": { "tags": [ "Partner Common" ], "description": "Get the list of drop ship delivery service order line statuses.", "operationId": "getFulfillmentOrderLineStatuses", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Drop ship delivery service order line status list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderLineStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderLineStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443", "psapcl73.jewelry.stab:8443", "psapcl74.jewelry.stab:8443", "psagcl85.jewelry.stab:8443", "psagcl86.jewelry.stab:8443" ], "default": "api-uat.jtv.com" } } }, { "url": "https://{prod-host}/api/1.0", "description": "PROD", "variables": { "prod-host": { "enum": [ "api.jtv.com", "partner-api.jtv.com" ], "default": "api.jtv.com" } } } ] } }, "/partner-common/fulfillment-delivery-service-order-line-status-class": { "get": { "tags": [ "Partner Common" ], "description": "Get the list of drop ship delivery service order line status classes.", "operationId": "getFulfillmentOrderLineStatusClasses", "parameters": [ { "name": "X-JTV-CONVERSATION-ID", "in": "header", "description": "Optional. A unique identifier generated for each request.", "schema": { "type": "string" } }, { "name": "X-Requested-With", "in": "header", "description": "Required. Identifies mechanism of request issuer. Any value allowed that is non-null, non-empty.", "required": true, "schema": { "type": "string" }, "example": "XMLHttpRequest" }, { "name": "Origin", "in": "header", "description": "Required field only if Referer header is not provided. Origin of the request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "Referer", "in": "header", "description": "Required field only if Origin header is not provided. Referrer of the Request.", "required": true, "schema": { "type": "string" }, "example": "https://psapdl38.jewelry.acn:8082" }, { "name": "X-JTV-CLIENT-REQUEST-TIME", "in": "header", "description": "Optional. The date/time of the request.", "example": "2004-07-04T12:08:56.235-07:00", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DateType" } } } } ], "responses": { "200": { "description": "Drop ship delivery service order line status class list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderLineStatusClassResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentDeliveryServiceOrderLineStatusClassResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "JWT Bearer Token": [] }, { "http://psapdl38.jewelry.acn:8090": [] }, { "https://account-qa.jtv.com": [] }, { "https://account-uat.jtv.com": [] }, { "https://account.jtv.com": [] } ], "servers": [ { "url": "/api/1.0", "variables": {} }, { "url": "https://{dev-host}/api/1.0", "description": "DEV", "variables": { "dev-host": { "enum": [ "api-dev.jtv.com", "partner-api-dev.jtv.com", "psapdl38.jewelry.acn:8082", "psapdl38.jewelry.acn:8084", "psapdl38.jewelry.acn:8085", "psapdl86.jewelry.acn:8082", "psapdl115.jewelry.dev:13000", "psapdl115.jewelry.dev:14000", "psapdl115.jewelry.dev:15000", "psapdl126.jewelry.dev:8082", "psapdl126.jewelry.dev:8083", "psapdl126.jewelry.dev:8084", "psapdl128.jewelry.acn:8082", "psapdl128.jewelry.acn:8083", "psapdl128.jewelry.acn:8084", "psbedl52.jewelry.dev:8082", "psbedl52.jewelry.dev:8083", "psbedl52.jewelry.dev:8084" ], "default": "psapdl38.jewelry.acn:8082" } } }, { "url": "https://{qa-host}/api/1.0", "description": "QA", "variables": { "qa-host": { "enum": [ "api-qa.jtv.com", "partner-api-qa.jtv.com", "psapql178.jewelry.qa:9000", "psapql179.jewelry.qa:9000", "psagql74.jewelry.qa:9000", "psagql75.jewelry.qa:9000", "psagql89.jewelry.qa:10000", "psagql89.jewelry.qa:14000" ], "default": "api-qa.jtv.com" } } }, { "url": "https://{uat-host}/api/1.0", "description": "UAT", "variables": { "uat-host": { "enum": [ "api-uat.jtv.com", "partner-api-uat.jtv.com", "psapcl75.jewelry.stab:8443", "psapcl76.jewelry.stab:8443",