{ "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", "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-order-cancel-reason": { "get": { "tags": [ "Partner Common" ], "description": "Get order cancel reason list.", "operationId": "getFulfillmentOrderCancelReasons", "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 cancel reason list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetOrderCancelReasonListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetOrderCancelReasonListResponse" } } } }, "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-shipment-group-header-status": { "get": { "tags": [ "Partner Common" ], "description": "Get shipment group header status list.", "operationId": "getFulfillmentShipmentGroupHeaderStatuses", "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 shipment group header status list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentGroupHeaderStatusListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentGroupHeaderStatusListResponse" } } } }, "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-shipment-batch-header-status": { "get": { "tags": [ "Partner Common" ], "description": "Get shipment batch header status list.", "operationId": "getFulfillmentShipmentBatchHeaderStatuses", "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 shipment batch header status list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentBatchHeaderStatusListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentBatchHeaderStatusListResponse" } } } }, "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-shipment-batch-header-status-classification": { "get": { "tags": [ "Partner Common" ], "description": "Get shipment batch header status classification list.", "operationId": "getFulfillmentShipmentBatchHeaderStatusClassifications", "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 shipment batch header status classification list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentBatchHeaderStatusClassificationListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentBatchHeaderStatusClassificationListResponse" } } } }, "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-shipment-group-header-status-classification": { "get": { "tags": [ "Partner Common" ], "description": "Get shipment group header status classification list.", "operationId": "getFulfillmentShipmentGroupHeaderStatusClassifications", "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 shipment group header status classification list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentGroupHeaderStatusClassificationListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentGroupHeaderStatusClassificationListResponse" } } } }, "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/media-subjects": { "get": { "tags": [ "Partner Common" ], "description": "Get media content media subjects.", "operationId": "getMediaContentMediaSubjects", "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 media content media subjects", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaSubjectResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaSubjectResponse" } } } }, "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/media-angles": { "get": { "tags": [ "Partner Common" ], "description": "Get media content media angles.", "operationId": "getMediaContentMediaAngles", "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 media content media angles", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaAngleResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaAngleResponse" } } } }, "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/media-backgrounds": { "get": { "tags": [ "Partner Common" ], "description": "Get media content media backgrounds.", "operationId": "getMediaContentMediaBackgrounds", "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 media content media backgrounds", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaBackgroundResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaBackgroundResponse" } } } }, "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/media-content-types": { "get": { "tags": [ "Partner Common" ], "description": "Get media content media content types.", "operationId": "getMediaContentMediaContentTypes", "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 media content media content types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaContentTypeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetMediaContentMediaContentTypeResponse" } } } }, "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/assortment-departments": { "get": { "tags": [ "Partner Common" ], "description": "Get assortment departments.", "operationId": "getAssortmentDepartments", "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 assortment departments", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetAssortmentDepartmentResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetAssortmentDepartmentResponse" } } } }, "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/assortment-header-status": { "get": { "tags": [ "Partner Common" ], "description": "Get assortment header statuses.", "operationId": "getAssortmentHeaderStatuses", "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": "All available assortment header statuses", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetAssortmentHeaderStatusesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetAssortmentHeaderStatusesResponse" } } } }, "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/assortment-fashion-style": { "get": { "tags": [ "Partner Common" ], "description": "Get assortment fashion styles.", "operationId": "getAssortmentFashionStyles", "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": "All available assortment fashion styles", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetAssortmentFashionStylesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetAssortmentFashionStylesResponse" } } } }, "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/fulfillment-delivery-service-options": { "get": { "tags": [ "Partner Common" ], "description": "Get delivery Service Options.", "operationId": "getDeliveryServiceOptions", "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 delivery service options", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentServiceOptionsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentServiceOptionsResponse" } } } }, "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/order-delivery-service-options": { "get": { "tags": [ "Partner Common" ], "description": "Get order delivery Service Options.", "operationId": "getOrderDeliveryServiceOptions", "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-type", "in": "query", "description": "The order type for order service options.", "schema": { "type": "string", "enum": [ "REPLENISH", "REMOVAL", "ALL" ], "default": "ALL" }, "example": "ALL" } ], "responses": { "200": { "description": "Available order delivery service options", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetOrderServiceOptionsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetOrderServiceOptionsResponse" } } } }, "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/fulfillment-package-label-format": { "get": { "tags": [ "Partner Common" ], "description": "Get available package label formats.", "operationId": "getFulfillmentPackageLabelFormats", "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 package label formats", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentPackageLabelFormatsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentPackageLabelFormatsResponse" } } } }, "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/installment-billing-terms": { "get": { "tags": [ "Partner Common" ], "description": "Get installment billing terms.", "operationId": "getInstallmentBillingTerms", "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 installment billing terms", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetInstallmentBillingTermsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetInstallmentBillingTermsResponse" } } } }, "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/bulk-import-header-status": { "get": { "tags": [ "Partner Common" ], "description": "Get bulk import header status.", "operationId": "getBulkImportHeaderStatus", "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 bulk import header status", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBulkImportHeaderStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBulkImportHeaderStatusResponse" } } } }, "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-common/curation-commission-rates": { "get": { "tags": [ "Partner Common" ], "description": "Get curation commission rates.", "operationId": "getCurationCommissionRates", "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": "Curation Commission Rates", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetCurationCommissionRatesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetCurationCommissionRatesResponse" } } } }, "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/curation-commission-rate-types": { "get": { "tags": [ "Partner Common" ], "description": "Get curation commission rate types.", "operationId": "getCurationCommissionRateTypes", "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": "Curation Commission Rate Types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetCurationCommissionRateTypeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetCurationCommissionRateTypeResponse" } } } }, "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/bulk-inventory-auto-queue-entry": { "post": { "tags": [ "Partner Common" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "saveBulkInventoryAutoQueueEntry", "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/SaveBulkInventoryAutoQueueEntryRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SaveBulkInventoryAutoQueueEntryRequest" } } } }, "responses": { "201": { "description": "Bulk Inventory Auto Queue entry saved Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoQueueEntryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoQueueEntryResponse" } } } }, "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-common/saveBulkInventoryAutoQueueEntry": { "post": { "tags": [ "Partner Common" ], "description": "Get the automatic bulk inventory config for a partner.", "operationId": "saveBulkInventoryAutoQueueEntryDeprecated", "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/SaveBulkInventoryAutoQueueEntryRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SaveBulkInventoryAutoQueueEntryRequest" } } } }, "responses": { "201": { "description": "Bulk Inventory Auto Queue entry saved Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoQueueEntryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerBulkImportService_SaveBulkInventoryAutoQueueEntryResponse" } } } }, "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-common/unit-of-measure": { "get": { "tags": [ "Partner Common" ], "description": "Get available units of measure.", "operationId": "getUnitOfMeasure", "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": "base-quantity-code", "in": "query", "description": "Length", "schema": { "type": "string", "enum": [ "LENGTH", "MASS", "TIME", "ELECTRIC_CURRENT", "THERMODYNAMIC_TEMPERATURE", "AMOUNT_OF_SUBSTANCE", "LUMINOUS_INTENSITY" ] }, "example": "LENGTH" } ], "responses": { "200": { "description": "Available units of measure", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetUnitOfMeasureResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetUnitOfMeasureResponse" } } } }, "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/curation-list-header-types": { "get": { "tags": [ "Partner Common" ], "description": "Get curation list header types.", "operationId": "getPartnerCurationListHeaderTypes", "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": "Curation List Header Types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetCurationListHeaderTypeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetCurationListHeaderTypeResponse" } } } }, "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-country": { "get": { "tags": [ "Partner Common" ], "description": "Get available bank transfer countries.", "operationId": "getBankTransferCountries", "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": "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 } ], "responses": { "200": { "description": "Available bank transfer countries", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBankTransferCountriesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBankTransferCountriesResponse" } } } }, "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/standard-date-range": { "get": { "tags": [ "Partner Common" ], "description": "Get standard date range list.", "operationId": "getStandardDateRanges", "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 standard date range list", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetStandardDateRangeListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetStandardDateRangeListResponse" } } } }, "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/user-profile-specializations": { "get": { "tags": [ "Partner Common" ], "description": "Get user profile specializations.", "operationId": "getSpecializations", "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 specializations", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetSpecializationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetSpecializationResponse" } } } }, "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/fulfillment-shipment-statuses": { "get": { "tags": [ "Partner Common" ], "description": "Get partner fulfillment shipment header statuses.", "operationId": "getFulfillmentShipmentStatuses", "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 fulfillment shipment header statuses", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentStatusResponse" } } } }, "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/fulfillment-shipment-status-classification": { "get": { "tags": [ "Partner Common" ], "description": "Get partner fulfillment status classifications.", "operationId": "getFulfillmentStatusClassifications", "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 fulfillment status classifications", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentStatusClassificationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentShipmentStatusClassificationResponse" } } } }, "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/fulfillment-optimization-rules": { "get": { "tags": [ "Partner Common" ], "description": "Get delivery service optimization rules.", "operationId": "getOptimizationRules", "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 delivery service optimization rules", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetOptimizationRulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetOptimizationRulesResponse" } } } }, "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/receipt-line-type": { "get": { "tags": [ "Partner Common" ], "description": "Get available receipt line types.", "operationId": "getReceiptLineTypes", "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 receipt line types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptLineTypesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptLineTypesResponse" } } } }, "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/product-listing-label": { "get": { "tags": [ "Partner Common" ], "description": "Get available product listing labels.", "operationId": "getProductListingLabels", "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 product listing labels", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetProductListingLabelsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetProductListingLabelsResponse" } } } }, "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/receipt-line-return-reason-group": { "get": { "tags": [ "Partner Common" ], "description": "Get available receipt line reason groups.", "operationId": "getReceiptLineReasonGroups", "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 receipt line reason groups", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptLineReasonGroupsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptLineReasonGroupsResponse" } } } }, "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/receipt-line-cancel-reason-group": { "get": { "tags": [ "Partner Common" ], "description": "Get available receipt line cancel reason groups.", "operationId": "getReceiptLineCancelReasonGroups", "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 receipt line cancel reason groups", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptLineCancelReasonGroupsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptLineCancelReasonGroupsResponse" } } } }, "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/receipt-header-status-classification": { "get": { "tags": [ "Partner Common" ], "description": "Get available receipt header status classifications.", "operationId": "getReceiptHeaderStatusClassifications", "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 receipt header status classifications", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptHeaderStatusClassificationsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptHeaderStatusClassificationsResponse" } } } }, "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/receipt-header-status": { "get": { "tags": [ "Partner Common" ], "description": "Get available receipt header statuses.", "operationId": "getReceiptHeaderStatusList", "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 receipt header statuses", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptHeaderStatusListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetReceiptHeaderStatusListResponse" } } } }, "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/bulk-import-header-type": { "get": { "tags": [ "Partner Common" ], "description": "Get bulk import header types.", "operationId": "getBulkImportHeaderTypes", "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 bulk import header types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBulkImportHeaderTypeListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetBulkImportHeaderTypeListResponse" } } } }, "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-common/fulfillment-lead-time": { "get": { "tags": [ "Partner Common" ], "description": "Get available fulfillment lead times.", "operationId": "getFulfillmentLeadTime", "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": "fulfillment-lead-time-unit-of-measure", "in": "query", "description": "day", "schema": { "type": "string", "description": "Describes the fulfillment lead time unit of measure", "xml": { "name": "fulfillmentLeadTimeUnitOfMeasureCode" }, "enum": [ "DAY" ] }, "example": "DAY" } ], "responses": { "200": { "description": "Available fulfillment lead times", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentLeadTimeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCommonService_GetFulfillmentLeadTimeResponse" } } } }, "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}/curation-assortment": { "get": { "tags": [ "Partner Curation Assortment" ], "description": "Get assortment headers", "operationId": "getPartnerCurationAssortmentHeaderList", "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, Default = 25", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting index from which to pull orders from the ordered set. Min = 1, Default = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 }, { "name": "keyword-search", "in": "query", "description": "A regular expression search string. The search will match against the assortment number.", "schema": { "type": "string" }, "example": "red* blue" }, { "name": "assortment-status", "in": "query", "description": "A collection of the desired assortment status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_ACTIVATION" }, { "name": "assortment-fashion-style", "in": "query", "description": "A collection of the desired assortment fashion style codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "EDGY" }, { "name": "assortment-department", "in": "query", "description": "A collection of the desired assortment department codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "MEN" }, { "name": "style-listing-id", "in": "query", "description": "A collection of the desired style listing universal unique identifiers", "schema": { "type": "array", "items": { "type": "string" } }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "date-range-code", "in": "query", "description": "Optional standard minimum date range code to filter the list of assortment headers. This takes precedence over custom start/end date.", "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": "start-date", "in": "query", "description": "The inclusive starting date for the assortment create date search. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateParameter" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "end-date", "in": "query", "description": "The inclusive ending date for the assortment create date search. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateParameter" }, "example": "2001-07-04T12:08:56.235-07:00" } ], "responses": { "200": { "description": "Partner curation assortment header list returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderListResponse" } } } }, "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 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" } } } ] }, "post": { "tags": [ "Partner Curation Assortment" ], "description": "Create assortment header.", "operationId": "createPartnerCurationAssortmentHeader", "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/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentHeaderRequest" } } } }, "responses": { "201": { "description": "Assortment header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentHeaderResponse" } } } }, "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 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/{partner-id}/curation-assortment/{assortment-header-id}": { "get": { "tags": [ "Partner Curation Assortment" ], "description": "Get partner curation assortment header.", "operationId": "getPartnerCurationAssortmentHeader", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Partner curation assortment header", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Curation Assortment" ], "description": "Delete a curation assortment header.", "operationId": "deletePartnerCurationAssortmentHeader", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Curation Assortment header deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_DeletePartnerCurationAssortmentHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_DeletePartnerCurationAssortmentHeaderResponse" } } } }, "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 ID or Order Header 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/{partner-id}/curation-assortment/{assortment-header-id}/assortment-line": { "get": { "tags": [ "Partner Curation Assortment" ], "description": "Get partner curation assortment lines.", "operationId": "getPartnerCurationAssortmentLines", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Curation Assortment lines returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentLinesResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner Curation Assortment" ], "description": "Create partner curation assortment lines.", "operationId": "createPartnerCurationAssortmentLines", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header'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/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLinesRequest" } } } }, "responses": { "200": { "description": "Curation Assortment Line Create request processed successfully. Check response for potential error codes.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLinesResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Curation Assortment" ], "description": "Delete partner curation assortment lines.", "operationId": "deletePartnerCurationAssortmentLines", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header'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/PartnerCurationAssortmentService_DeletePartnerCurationAssortmentLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_DeletePartnerCurationAssortmentLinesRequest" } } } }, "responses": { "200": { "description": "Partner curation assortment line(s) deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_DeletePartnerCurationAssortmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_DeletePartnerCurationAssortmentLinesResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Curation Assortment" ], "description": "Update partner curation assortment lines.", "operationId": "updatePartnerCurationAssortmentLines", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header'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/PartnerCurationAssortmentService_UpdatePartnerCurationAssortmentLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_UpdatePartnerCurationAssortmentLinesRequest" } } } }, "responses": { "200": { "description": "Partner curation assortment line(s) updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_UpdatePartnerCurationAssortmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_UpdatePartnerCurationAssortmentLinesResponse" } } } }, "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}/curation-assortment/{assortment-header-id}/assortment-line/{assortment-line-id}": { "get": { "tags": [ "Partner Curation Assortment" ], "description": "View partner curation assortment line details", "operationId": "getPartnerCurationAssortmentLine", "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": "assortment-header-id", "in": "path", "description": "The curation assortment header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "assortment-line-id", "in": "path", "description": "The curation assortment line's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner curation assortment line.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentLineResponse" } } } }, "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}/partner-curation-list": { "get": { "tags": [ "Partner Curation List" ], "description": "Get Curation List.", "operationId": "getCurationList", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "201": { "description": "Fetched Curation List successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationListService_GetPartnerCurationListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationListService_GetPartnerCurationListResponse" } } } }, "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 ID or some other aspect of request 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}/curation-profile": { "get": { "tags": [ "Partner Curation Profile" ], "description": "Get curation profile list.", "operationId": "getPartnerCurationProfileList", "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": { "200": { "description": "Curation Profile List", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationProfileService_GetPartnerCurationProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationProfileService_GetPartnerCurationProfileResponse" } } } }, "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 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}/partner-curation-rate-schedule": { "get": { "tags": [ "Partner Curation Rate Schedule" ], "description": "Get List of Curation Rate Schedules", "operationId": "getCurationRateSchedules", "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 identifier (UUID).", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "rate-type-code", "in": "query", "schema": { "type": "string", "description": "The type of commission being offered. (LOOK_COMMISSION or ASSORT_COMMISSION) ", "example": "LOOK_COMMISSION" } }, { "name": "rate-code", "in": "query", "schema": { "type": "string", "description": "The amount ( fixed, percentage ) of commission being offered.", "example": "10_PERCENT" } }, { "name": "style-listing-id", "in": "query", "schema": { "type": "string", "description": "The unique identifier (UUID) of the style listing", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "style-rate-schedule-id", "in": "query", "schema": { "type": "string", "description": "The unique identifier (UUID) of the style rate schedule", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "status", "in": "query", "schema": { "type": "string", "description": "The style rate schedule status: all, active, inactive ( default = all )", "example": "all", "enum": [ "all", "active", "inactive" ] } }, { "name": "start-index", "in": "query", "schema": { "type": "integer", "description": "The starting index for the paged return list ( min = 1, default = 1 )", "format": "int32", "example": 1, "default": 1 } }, { "name": "page-size", "in": "query", "schema": { "type": "integer", "description": "The number of schedules in each page of the paged return list ( min = 1, max = 100, default = 25 )", "format": "int32", "example": 25, "default": 25 } }, { "name": "sort-option", "in": "query", "schema": { "type": "string", "description": "The sort order of the paged return list ( default = start_time_desc) ", "example": "start_time_desc", "enum": [ "start_time_asc", "start_time_desc" ], "default": "start_time_desc" } } ], "responses": { "200": { "description": "The list of curation rate schedules matching the query parameters was returned", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_GetCurationRateSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_GetCurationRateSchedulesResponse" } } } }, "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 ID or some other aspect of request 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" } } } ] }, "post": { "tags": [ "Partner Curation Rate Schedule" ], "description": "Create Curation Rate Schedule.", "operationId": "createCurationRateSchedule", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CreateCurationRateScheduleRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CreateCurationRateScheduleRequest" } } } }, "responses": { "200": { "description": "The list of curation rate schedules was processed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CreatePartnerCurationRateScheduleResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CreatePartnerCurationRateScheduleResponse" } } } }, "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 ID or some other aspect of request 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" } } } ] }, "delete": { "tags": [ "Partner Curation Rate Schedule" ], "description": "Delete Curation Rate Schedule.", "operationId": "deleteCurationRateSchedule", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_DeleteCurationRateScheduleRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_DeleteCurationRateScheduleRequest" } } } }, "responses": { "200": { "description": "The list of curation rate schedules was processed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_DeletePartnerCurationRateScheduleResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_DeletePartnerCurationRateScheduleResponse" } } } }, "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 ID or some other aspect of request 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}/customer-order/{order-number}": { "get": { "tags": [ "Partner Customer Order" ], "description": "Get order details for a partner customer order or return order by order number", "operationId": "getPartnerCustomerOrderDetail", "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-number", "in": "path", "required": true, "schema": { "type": "string", "description": "The customer order number - 9 digits max.", "example": "123456789" } } ], "responses": { "200": { "description": "Partner customer order retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_GetCustomerOrderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_GetCustomerOrderDetailResponse" } } } }, "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}/customer-order-header/{order-header-id}": { "get": { "tags": [ "Partner Customer Order Header" ], "description": "Fetch partner customer order header", "operationId": "getCustomerOrderHeader_1", "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 id - 9 digits max.", "example": "123456789" } } ], "responses": { "200": { "description": "Partner customer order header retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_FetchOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_FetchOrderHeaderResponse" } } } }, "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 Customer Order Header" ], "description": "Cancel partner customer sales order header", "operationId": "cancelSalesOrderHeader", "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 id - 9 digits max.", "example": "123456789" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CancelSalesOrderReasonCodeRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CancelSalesOrderReasonCodeRequest" } } } }, "responses": { "200": { "description": "The order header has been cancelled", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "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}/customer-order-header/{order-header-id}/customer-order-line/{order-line-id}": { "get": { "tags": [ "Partner Customer Order Header" ], "description": "Fetch a customer sales order line", "operationId": "getCustomerOrderLineDetails", "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 id - 9 digits max.", "example": "123456789" } }, { "name": "order-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order line id - 9 digits max.", "example": "123456789" } } ], "responses": { "200": { "description": "The order line has been cancelled", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_FetchOrderLineDetailsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_FetchOrderLineDetailsResponse" } } } }, "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 Customer Order Header" ], "description": "Cancel partner customer sales order line", "operationId": "cancelSalesOrderLine", "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 id - 9 digits max.", "example": "123456789" } }, { "name": "order-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order line id - 9 digits max.", "example": "123456789" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CancelSalesOrderReasonCodeRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CancelSalesOrderReasonCodeRequest" } } } }, "responses": { "200": { "description": "The order line has been cancelled", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "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}/customer-order-header/{order-header-id}/customer-order-line": { "get": { "tags": [ "Partner Customer Order Header" ], "description": "Get partner customer sales order lines", "operationId": "getCustomerOrderLines", "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 id - 9 digits max.", "example": "123456789" } } ], "responses": { "200": { "description": "Partner customer sales order lines retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_GetPartnerCustomerOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerCustomerOrderService_GetPartnerCustomerOrderLinesResponse" } } } }, "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}/delivery-service-order": { "get": { "tags": [ "Partner Delivery Service Order" ], "description": "Get Delivery Service Order Headers", "operationId": "getDeliveryServiceOrderHeaders", "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, Default = 25", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting index from which to pull orders from the ordered set. Min = 1, Default = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 }, { "name": "keyword-search", "in": "query", "description": "A regular expression search string. The search will match against delivery service order number, delivery service order line, shipment batch number, shipment group number, and customer shipment number.", "schema": { "type": "string" }, "example": "red* blue" }, { "name": "order-status", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_COMPLETION" }, { "name": "order-status-classification", "in": "query", "description": "A collection of the desired order status classification codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "INCOMPLETE" }, { "name": "shipment-batch-header-id", "in": "query", "description": "A collection of the desired shipment batch header universal unique identifiers", "schema": { "type": "array", "items": { "type": "string" } }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "date-range-code", "in": "query", "description": "Optional standard minimum date range code to filter the list of delivery service orders. This takes precedence over custom start/end date.", "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": "start-date", "in": "query", "description": "The inclusive starting date for the order header search. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateParameter" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "end-date", "in": "query", "description": "The inclusive ending date for the order header search. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateParameter" }, "example": "2001-07-04T12:08:56.235-07:00" } ], "responses": { "200": { "description": "Delivery Service order headers returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderHeadersResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner Delivery Service Order" ], "description": "Create Delivery Service Order Header", "operationId": "createDeliveryServiceOrderHeader", "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/PartnerDeliveryServiceOrderService_CreatePartnerFulfillmentShipmentHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_CreatePartnerFulfillmentShipmentHeaderRequest" } } } }, "responses": { "201": { "description": "Delivery Service order header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderHeaderResponse" } } } }, "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 ID or other identifier 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}/delivery-service-order/{order-header-id}": { "get": { "tags": [ "Partner Delivery Service Order" ], "description": "Get Delivery Service Order Header Detail", "operationId": "getDeliveryServiceOrderHeaderDetail", "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": "order-header-id", "in": "path", "description": "The delivery service order header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Delivery Service order header detail returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderHeaderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderHeaderDetailResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "delete": { "tags": [ "Partner Delivery Service Order" ], "description": "Delete a delivery service order header for a partner.", "operationId": "deleteDeliveryServiceOrderHeader", "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": "order-header-id", "in": "path", "description": "The delivery service order header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Delivery Service Order header deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeletePartnerDeliveryServiceOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeletePartnerDeliveryServiceOrderHeaderResponse" } } } }, "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 ID or Order Header 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/{partner-id}/delivery-service-order/{order-header-id}/delivery-service-order-line/{order-line-id}": { "get": { "tags": [ "Partner Delivery Service Order" ], "description": "Get Delivery Service Order Header Line", "operationId": "getDeliveryServiceOrderLineDetail", "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": "order-header-id", "in": "path", "description": "The delivery service order header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "order-line-id", "in": "path", "description": "The delivery service order line's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Delivery Service order header detail returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetDeliveryServiceOrderLineDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetDeliveryServiceOrderLineDetailResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "delete": { "tags": [ "Partner Delivery Service Order" ], "description": "Delete delivery service order lines for a partner.", "operationId": "deleteDeliveryServiceOrderLine", "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": "order-header-id", "in": "path", "description": "The delivery service order header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "order-line-id", "in": "path", "description": "The delivery service order line's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Delivery Service Order lines deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeletePartnerDeliveryServiceOrderLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeletePartnerDeliveryServiceOrderLineResponse" } } } }, "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 ID or Delivery Service Order Line 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/{partner-id}/delivery-service-order/{order-header-id}/delivery-service-order-line": { "get": { "tags": [ "Partner Delivery Service Order" ], "description": "Get Delivery Service Order Header Lines", "operationId": "getDeliveryServiceOrderLines", "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": "order-header-id", "in": "path", "description": "The delivery service order header's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "page-size", "in": "query", "schema": { "type": "integer", "description": "The number of records per page of the paged result set. Min = 1, Max = 100, Default = 25", "format": "int32", "example": 10, "default": 25 } }, { "name": "start-index", "in": "query", "schema": { "type": "integer", "description": "The starting index from which to pull lines from the ordered set. Min = 1, Default = 1", "format": "int32", "example": 26, "default": 1 } } ], "responses": { "200": { "description": "Delivery Service order lines returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderLinesResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner Delivery Service Order" ], "description": "Create Delivery Service Order Line", "operationId": "createDeliveryServiceOrderLines", "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": "order-header-id", "in": "path", "description": "The delivery service order header'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/PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderLinesRequest" } } } }, "responses": { "201": { "description": "Delivery Service order lines update successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderLinesResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "patch": { "tags": [ "Partner Delivery Service Order" ], "description": "Update Delivery Service Order Header Lines", "operationId": "updateDeliveryServiceOrderLines", "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": "order-header-id", "in": "path", "description": "The delivery service order header'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/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLinesRequest" } } } }, "responses": { "200": { "description": "Delivery Service order lines update successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLinesResponse" } } } }, "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 ID or other identifier 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}/delivery-service-order/{order-header-id}/delivery-service-order-line-status": { "post": { "tags": [ "Partner Delivery Service Order" ], "description": "Update Delivery Service Order Header Line Status", "operationId": "updateDeliveryServiceOrderLineStatus", "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": "order-header-id", "in": "path", "description": "The delivery service order header'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/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLineStatusRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLineStatusRequest" } } } }, "responses": { "200": { "description": "Delivery Service order line status update successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLineStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLineStatusResponse" } } } }, "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 ID or other identifier 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}/employee/{employee-user-account-id}": { "get": { "tags": [ "Partner Employee" ], "description": "Get partner employee based on employee user account id.", "operationId": "getPartnerEmployee", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "employee-user-account-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The employee user account's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Employee", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEmployeeService_GetPartnerEmployeeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEmployeeService_GetPartnerEmployeeResponse" } } } }, "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}/employee": { "get": { "tags": [ "Partner Employee" ], "description": "Get partner employees list for a partner.", "operationId": "getAllPartnerEmployees", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "employee-filter", "in": "query", "schema": { "type": "string", "description": "The partner employee filter", "example": "ALL", "enum": [ "ALL", "ASSIGNED", "ME", "ALL", "ASSIGNED", "ME" ], "default": "ASSIGNED" } }, { "name": "employee-type-filter", "in": "query", "schema": { "type": "string", "description": "The employee type filter", "example": "PARTNER_SUCCESS_MANAGER", "enum": [ "PARTNER_SUCCESS_MANAGER", "MERCHANDISING_ADMINISTRATOR", "FINANCE_ADMINISTRATOR", "COMPLIANCE_ADMINISTRATOR", "PARTNER_SUCCESS_MANAGER", "MERCHANDISING_ADMINISTRATOR", "FINANCE_ADMINISTRATOR", "COMPLIANCE_ADMINISTRATOR" ] } }, { "name": "page-size", "in": "query", "schema": { "type": "integer", "description": "Number of employees to return. Max = 100.", "format": "int32", "example": 10, "default": 25 } }, { "name": "start-index", "in": "query", "schema": { "type": "integer", "description": "The starting index of employees from the ordered set. Min = 1.", "format": "int32", "example": 10, "default": 1 } } ], "responses": { "200": { "description": "Partner Employees", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEmployeeService_GetAllPartnerEmployeesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEmployeeService_GetAllPartnerEmployeesResponse" } } } }, "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}/employee/{employee-user-account-id}/permission": { "get": { "tags": [ "Partner Employee" ], "description": "Get permissions for partner employee.", "operationId": "getPartnerEmployeePermissions", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "employee-user-account-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The employee user account's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "permission-filter", "in": "query", "schema": { "type": "string", "description": "The partner employee permission filter", "example": "ALL", "enum": [ "ALL", "ASSIGNED", "ALL", "ASSIGNED" ], "default": "ALL" } } ], "responses": { "200": { "description": "Partner Employee Permissions", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_GetPartnerEmployeePermissionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_GetPartnerEmployeePermissionResponse" } } } }, "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}/service-enrollment": { "get": { "tags": [ "Partner Service Enrollment" ], "description": "Get a partner's service enrollments", "operationId": "getPartnerServiceEnrollments", "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": "service-classification-code", "in": "query", "description": "List of enrollment service's classification codes to filter.", "schema": { "type": "array", "items": { "type": "string" } }, "example": "SHIPPING_CARRIER" } ], "responses": { "200": { "description": "Enrollment Services", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_GetPartnerServicesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_GetPartnerServicesResponse" } } } }, "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 Service Enrollment" ], "description": "Enroll a partner in a service", "operationId": "enrollPartnerInService", "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/PartnerEnrollmentService_PartnerServiceEnrollmentRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_PartnerServiceEnrollmentRequest" } } } }, "responses": { "201": { "description": "Partner was Enrolled in Service", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_PartnerServiceEnrollmentResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_PartnerServiceEnrollmentResponse" } } } }, "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}/service-offering": { "get": { "tags": [ "Partner Service Offering" ], "description": "Get a partner's services eligible for enrollment by platform", "operationId": "getPartnerServiceOffering", "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": { "200": { "description": "Service Offering", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_GetPartnerServiceOfferingResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerEnrollmentService_GetPartnerServiceOfferingResponse" } } } }, "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}/fulfillment-shipment-header/{shipment-header-id}/package-header/{package-header-id}/package-line": { "get": { "tags": [ "Partner Fulfillment" ], "description": "fetch partner fulfillment package lines", "operationId": "fetchPackageLines", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package line's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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": "sort-ascending", "in": "query", "description": "Package line number sorting option; true=ascending, false=descending", "schema": { "type": "string", "default": "true" }, "example": true } ], "responses": { "200": { "description": "Get package line list successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageLinesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Fulfillment" ], "description": "Create partner fulfillment package line", "operationId": "createPackageLine", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePackageLineRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePackageLineRequest" } } } }, "responses": { "201": { "description": "Package header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackageLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackageLineResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Fulfillment" ], "description": "Delete partner fulfillment package lines", "operationId": "deletePackageLine", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_DeletePackageLInesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_DeletePackageLInesRequest" } } } }, "responses": { "303": { "description": "Redirect to get the updated package lines with new package line number", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Fulfillment" ], "description": "Delete partner fulfillment package lines", "operationId": "updatePackageLines", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageLinesRequest" } } } }, "responses": { "200": { "description": "Package lines are updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageLinesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-header/{shipment-header-id}/package-header": { "get": { "tags": [ "Partner Fulfillment" ], "description": "Get a list of partner fulfillment package headers for the shipment", "operationId": "fetchPackageHeaders", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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": "sort-ascending", "in": "query", "description": "Package ordinal sorting option; true=ascending, false=descending", "schema": { "type": "string", "default": "true" }, "example": true } ], "responses": { "200": { "description": "Get package header list successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageHeadersResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Fulfillment" ], "description": "Create partner fulfillment package header", "operationId": "createPackageHeader", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePartnerFulfillmentPackageHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePartnerFulfillmentPackageHeaderRequest" } } } }, "responses": { "201": { "description": "Package header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackagerHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackagerHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Fulfillment" ], "description": "Delete partner fulfillment package headers", "operationId": "deletePackageHeaders", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_DeletePackageHeadersRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_DeletePackageHeadersRequest" } } } }, "responses": { "303": { "description": "Redirect to get the updated package headers with new package name and ordinal", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Fulfillment" ], "description": "Update a list of partner fulfillment package headers", "operationId": "updatePackageHeaders", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageHeaderListRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageHeaderListRequest" } } } }, "responses": { "200": { "description": "Package header list updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-header/{shipment-header-id}/package-header/{package-header-id}": { "get": { "tags": [ "Partner Fulfillment" ], "description": "Get the partner fulfillment package header", "operationId": "fetchPackageHeader", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Get package header successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-header/{shipment-header-id}/package-header/{package-header-id}/package-line/{package-line-id}": { "get": { "tags": [ "Partner Fulfillment" ], "description": "fetch partner fulfillment package line", "operationId": "fetchPackageLine", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package line's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Get package line successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPackageLineResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-package-labels": { "post": { "tags": [ "Partner Fulfillment" ], "description": "Create partner fulfillment package labels", "operationId": "createPartnerPackageLabels", "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/PartnerFulfillmentPackageService_CreatePackageLabelsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePackageLabelsRequest" } } }, "required": true }, "responses": { "200": { "description": "Package label PDFs created successfully" }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "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" } } } ] } }, "/partner/{partner-id}/fulfillment-package-manifest": { "post": { "tags": [ "Partner Fulfillment" ], "description": "Create partner fulfillment package manifest", "operationId": "createPartnerPackageManifest", "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/PartnerFulfillmentPackageService_CreatePackageManifestRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePackageManifestRequest" } } }, "required": true }, "responses": { "200": { "description": "Package manifest PDFs created successfully" }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "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" } } } ] } }, "/partner/{partner-id}/fulfillment-package-measurement-preset": { "get": { "tags": [ "Partner Fulfillment" ], "description": "Get partner fulfillment package measurement preset list for a partner.", "operationId": "getPartnerPackageMeasurementPresets", "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": "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": "deleted", "in": "query", "description": "Used to show/not show deleted presets", "schema": { "type": "string", "default": "true" }, "example": true } ], "responses": { "200": { "description": "Partner Package Measurement Presets", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPartnerPackageMeasurementsPresetsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPartnerPackageMeasurementsPresetsResponse" } } } }, "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 Fulfillment" ], "description": "Create partner fulfillment package measurement preset", "operationId": "createPartnerPackageMeasurementPreset", "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/PartnerFulfillmentPackageService_CreatePackageMeasurementPresetRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_CreatePackageMeasurementPresetRequest" } } } }, "responses": { "201": { "description": "Package measurement preset created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackageManagementPresetResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackageManagementPresetResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-package-measurement-preset/{package-measurement-preset-id}": { "get": { "tags": [ "Partner Fulfillment" ], "description": "Get partner fulfillment package measurement preset detail for a partner.", "operationId": "getPartnerPackageMeasurementPresetByUuid", "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": "package-measurement-preset-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package measurement preset unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Package Measurement Preset Detail", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPartnerPackageMeasurementPresetByUuidResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetPartnerPackageMeasurementPresetByUuidResponse" } } } }, "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 Fulfillment" ], "description": "Update partner fulfillment package measurement preset", "operationId": "updatePartnerPackageMeasurementPreset", "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": "package-measurement-preset-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package measurement preset unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageMeasurementPresetRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageMeasurementPresetRequest" } } } }, "responses": { "201": { "description": "Package measurement preset updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Fulfillment" ], "description": "Delete partner fulfillment package measurement preset", "operationId": "deletePartnerPackageMeasurementPreset", "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": "package-measurement-preset-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package measurement preset unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Package measurement preset deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/shipment-header/{shipment-header-id}/package-header/{package-header-id}/tracking-events": { "get": { "tags": [ "Partner Fulfillment" ], "description": "Get tracking events for a package", "operationId": "getTrackingEvents", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Tracking events are returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetTrackingEventsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentService_GetTrackingEventsResponse" } } } }, "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 ID, Shipment Header ID, or Package Header 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/{partner-id}/fulfillment-shipment-header": { "get": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Get Fulfillment Shipment Header", "operationId": "getFulfillmentShipmentHeaders", "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": "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": "shipment-batch-header-id", "in": "query", "description": "The shipment batch header's unique universal identifier.", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "shipment-group-header-id", "in": "query", "description": "The shipment group header's unique universal identifier.", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "resources", "in": "query", "description": "A resource to return in the response. Provide this parameter multiple times to have the service return multiple resource types. SHIPMENT_HEADER is assumed if no resources are explicitly requested", "schema": { "type": "array", "description": "A resource to return in the response. Provide this parameter multiple times to have the service return multiple resource types. SHIPMENT_HEADER is assumed if no resources are explicitly requested", "items": { "type": "string", "description": "A resource to return in the response. Provide this parameter multiple times to have the service return multiple resource types. SHIPMENT_HEADER is assumed if no resources are explicitly requested", "enum": [ "SHIPMENT_HEADER", "SHIPMENT_LINE", "PACKAGE_HEADER", "PACKAGE_LINE" ] }, "enum": [ "SHIPMENT_HEADER", "SHIPMENT_LINE", "PACKAGE_HEADER", "PACKAGE_LINE" ] }, "example": "SHIPMENT_LINE" }, { "name": "shipment-number", "in": "query", "description": "The shipment number to scan search on.", "schema": { "type": "string" }, "example": "S382BUI5TY" }, { "name": "order-start-date", "in": "query", "description": "The inclusive starting filter by min order date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "order-end-date", "in": "query", "description": "The inclusive ending filter by min order date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "order-date-range", "in": "query", "description": "Optional standard minimum order date range code to filter the list of shipment 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": "delivery-start-date", "in": "query", "description": "The inclusive starting filter by expected delivery date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "delivery-end-date", "in": "query", "description": "The inclusive ending filter by expected delivery date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "delivery-date-range", "in": "query", "description": "Optional standard expected delivery date range code to filter the list of shipment 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": "ship-address-id", "in": "query", "description": "The unique UUID of the customer shipping address to filter by", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "customer-id", "in": "query", "description": "The unique UUID of the customer to filter by", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "order-id", "in": "query", "description": "The order ref of the order to filter by", "schema": { "type": "integer", "format": "int32" }, "example": 2912394 }, { "name": "shipment-status", "in": "query", "description": "One or more shipment statuses to filter by. Acceptable values include: PENDING_RELEASE, HELD, RELEASED, READY_TO_PICK, READY_TO_PACK, READY_TO_SHIP, CANCELLED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED", "schema": { "type": "array", "description": "One or more shipment statuses to filter by. Acceptable values include: PENDING_RELEASE, HELD, RELEASED, READY_TO_PICK, READY_TO_PACK, READY_TO_SHIP, CANCELLED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED", "items": { "type": "string", "example": "PENDING_ACTIVATION", "enum": [ "PENDING_RELEASE", "HELD", "RELEASED", "READY_TO_PICK", "READY_TO_PACK", "READY_TO_SHIP", "CANCELLED", "SHIPPED", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED" ] } }, "example": "PENDING_RELEASE" }, { "name": "shipment-status-class", "in": "query", "description": "One or more shipment classification statuses to filter by. Acceptable values include: HELD, PENDING_FULFILLMENT, PENDING_SHIPMENT, SHIPPED, DELIVERED, CANCELLED", "schema": { "type": "array", "description": "One or more pricing statuses to filter by. Acceptable values include: HELD, PENDING_FULFILLMENT, PENDING_SHIPMENT, SHIPPED, DELIVERED, CANCELLED", "items": { "type": "string", "example": "REJECTED", "enum": [ "HELD", "PENDING_FULFILLMENT", "PENDING_SHIPMENT", "SHIPPED", "DELIVERED", "CANCELLED" ] } }, "example": "HELD" }, { "name": "keyword-search", "in": "query", "description": "A string to search the shipments by. Can include sku, style, order ref, supplier SKU/style numbers, customer number or keywords to perform a title search.", "schema": { "type": "string", "description": "A string to search the shipments by. Can include sku, style, order ref, supplier SKU/style numbers, customer number or keywords to perform a title search." } }, { "name": "sort-option", "in": "query", "description": "The attribute to sort shipment headers by", "schema": { "type": "string", "description": "The attribute to sort shipment headers by. Acceptable values include: EXPECTED_DELIVERY_DATE_ASC, EXPECTED_DELIVERY_DATE_DESC, MIN_ORDER_DATE_ASC, MIN_ORDER_DATE_DESC", "example": "EXPECTED_DELIVERY_DATE_ASC", "enum": [ "EXPECTED_DELIVERY_DATE_ASC", "EXPECTED_DELIVERY_DATE_DESC", "MIN_ORDER_DATE_ASC", "MIN_ORDER_DATE_DESC" ] }, "example": "EXPECTED_DELIVERY_DATE_ASC" } ], "responses": { "200": { "description": "Shipment headers returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentHeadersResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Create Fulfillment Shipment Header", "operationId": "createFulfillmentShipmentHeader", "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/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentHeaderRequest" } } } }, "responses": { "201": { "description": "Fulfillment shipment header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentHeaderResponse" } } } }, "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 ID or other identifier 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}/fulfillment-shipment-header/{shipment-header-id}": { "get": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Get Fulfillment Shipment Header Details", "operationId": "getFulfillmentShipmentHeaderDetails", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Shipment header returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentHeaderDetailsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentHeaderDetailsResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Update Fulfillment Shipment Header", "operationId": "updateFulfillmentShipmentHeader", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_UpdatePartnerFulfillmentShipmentHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_UpdatePartnerFulfillmentShipmentHeaderRequest" } } } }, "responses": { "201": { "description": "Fulfillment shipment header update successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_UpdatePartnerFulfillmentShipmentHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_UpdatePartnerFulfillmentShipmentHeaderResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "delete": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Delete Fulfillment Shipment Header", "operationId": "deleteFulfillmentShipmentHeader", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Fulfillment shipment header deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentHeaderResponse" } } } }, "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 ID or other identifier 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}/fulfillment-shipment-header/{shipment-header-id}/shipment-line": { "get": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Get Fulfillment Shipment Lines", "operationId": "getFulfillmentShipmentLines", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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": 5 }, { "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 } ], "responses": { "201": { "description": "Shipment lines returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentLinesResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Create Fulfillment Shipment Lines", "operationId": "createFulfillmentShipmentLines", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentLinesRequest" } } } }, "responses": { "201": { "description": "Fulfillment shipment lines created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentLinesResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Delete Fulfillment Shipment Lines", "operationId": "deleteFulfillmentShipmentLines", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentLinesRequest" } } } }, "responses": { "200": { "description": "Shipment lines are deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentLinesResponse" } } } }, "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}/fulfillment-shipment-header/{shipment-header-id}/shipment-line/{shipment-line-id}": { "get": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Get Fulfillment Shipment Line", "operationId": "getFulfillmentShipmentLine", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipment line's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Fulfillment shipment line retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentLineResponse" } } } }, "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}/seller-fulfilled-shipments-summary": { "get": { "tags": [ "Partner Fulfillment Shipment" ], "description": "Get Seller Fulfilled Shipments Summary", "operationId": "getSellerFulfilledShipmentsSummary", "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": "Shipment summary returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetSellerFulfilledShipmentsSummaryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_GetSellerFulfilledShipmentsSummaryResponse" } } } }, "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 ID or other identifier 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}/fulfillment-shipment-batch-header": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Get partner shipment batch headers for a partner.", "operationId": "getShipmentBatchHeaders", "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": "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": "batch-status", "in": "query", "description": "One or more batch statuses to filter by. Acceptable values include: READY_TO_PICK, IN_PROGRESS, SHIPPED, CANCELLED", "schema": { "type": "array", "description": "One or more batch statuses to filter by. Acceptable values include: READY_TO_PICK, IN_PROGRESS, SHIPPED, CANCELLED", "items": { "type": "string", "example": "READY_TO_PICK", "enum": [ "READY_TO_PICK", "IN_PROGRESS", "SHIPPED", "CANCELLED" ] } }, "example": "READY_TO_PICK" }, { "name": "batch-class", "in": "query", "description": "One or more batch status classifications to filter by. Acceptable values include: INCOMPLETE, COMPLETE, CANCELLED", "schema": { "type": "array", "description": "One or more batch status classifications to filter by. Acceptable values include: INCOMPLETE, COMPLETE, CANCELLED", "items": { "type": "string", "example": "INCOMPLETE", "enum": [ "INCOMPLETE, COMPLETE, CANCELLED" ] } }, "example": "INCOMPLETE" }, { "name": "standard-date-range", "in": "query", "description": "Optional standard date range code to filter the list of available transactions", "schema": { "type": "string", "description": "The financial standard date range code", "enum": [ "TODAY", "YESTERDAY", "PAST_7_DAYS", "PAST_30_DAYS", "PAST_60_DAYS", "PAST_3_MONTHS", "PAST_6_MONTHS", "PAST_YEAR" ] }, "example": "TODAY" }, { "name": "start-date", "in": "query", "description": "The start date to filter the list of available shipment batch headers", "example": "01/01/2021", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, { "name": "end-date", "in": "query", "description": "The end date to filter the list of available shipment batch headers", "example": "04/01/2021", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, { "name": "batch-number", "in": "query", "description": "A string to exact-match search the shipment batch headers by batch number.", "schema": { "type": "string", "description": "A string to exact-match search the shipment batch headers by batch number." } }, { "name": "keyword-search", "in": "query", "description": "A string to search the shipment batch headers by. Can include shipment batch number, shipment group number, shipment number, sku, style, or supplier numbers.", "schema": { "type": "string", "description": "A string to search the shipment batch headers by. Can include shipment batch number, shipment group number, shipment number, sku, style, or supplier numbers." } } ], "responses": { "200": { "description": "Partner Shipment Batch Headers", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeadersResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Fulfillment Shipment Batch" ], "description": "Create partner shipment batch header", "operationId": "createShipmentBatchHeader", "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/PartnerFulfillmentShipmentBatchService_CreateShipmentBatchHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_CreateShipmentBatchHeaderRequest" } } } }, "responses": { "201": { "description": "Shipment batch header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_CreateShipmentBatchHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_CreateShipmentBatchHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Get partner shipment batch header detail", "operationId": "getShipmentBatchHeader", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Shipment batch header has been returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Delete partner shipment batch header", "operationId": "deleteShipmentBatchHeader", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Shipment batch header has been deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/packing-list-label": { "post": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Create and return a pdf of shipment batch packing list", "operationId": "createShipmentBatchPackingListLabel", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Pdf for Shipment batch header packing list label has been returned successfully" }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "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" } } } ] } }, "/partner/{partner-id}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/export-details": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Generate shipment batch details report in CSV or Excel document", "operationId": "getShipmentBatchExportDocument", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "Accept", "in": "header", "required": true, "schema": { "type": "string", "description": "Export document type: application/xlsx|text/csv", "example": "application/xlsx|text/csv" } } ], "responses": { "200": { "description": "Shipment batch report generated successfully", "content": { "application/octet-stream": { "schema": { "type": "file", "format": "binary" } }, "text/csv": { "schema": { "type": "file", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; 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" } } } }, "404": { "description": "Shipment batch details not found for the partner", "content": { "application/json; 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" } } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/pick-list": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Get shipment batch pick list in CSV format.", "operationId": "getShipmentBatchPickList", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "sort-option", "in": "query", "schema": { "type": "string", "description": "Sort Option", "enum": [ "PICK_QUANTITY_ASC", "PICK_QUANTITY_DESC", "SUPPLIER_SKU_NUMBER_ASC", "SUPPLIER_SKU_NUMBER_DESC" ], "default": "PICK_QUANTITY_DESC" } }, { "name": "Accept", "in": "header", "required": true, "schema": { "type": "string", "description": "The pick list format: PDF|CSV", "example": "application/pdf|text/csv" } } ], "responses": { "200": { "description": "Specified financial statement for the partner", "content": { "application/pdf": { "schema": { "type": "file", "format": "binary" } }, "text/csv": { "schema": { "type": "file", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; 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" } } } }, "404": { "description": "No shipment batch exists for the partner", "content": { "application/json; 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" } } } } }, "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}/fulfillment-shipment-batch-header-preview": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Get summary of eligible shipments for partner shipment batch header creation", "operationId": "getShipmentBatchHeaderPreviewInfo", "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": "max-shipment-count", "in": "query", "schema": { "type": "integer", "description": "The maximum shipment count for the shipment batch", "format": "int32" } }, { "name": "max-shipment-group-count", "in": "query", "schema": { "type": "integer", "description": "The maximum shipment group count for the shipment batch", "format": "int32" } }, { "name": "max-sku-count", "in": "query", "schema": { "type": "integer", "description": "The maximum SKU count for the shipment batch", "format": "int32" } } ], "responses": { "200": { "description": "Summary of eligible shipments for partner shipment batch creation", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeaderPreviewResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeaderPreviewResponse" } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/fulfillment-shipment-group-header": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Get a list of shipment group headers", "operationId": "getShipmentGroupHeaders", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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": "keyword-search", "in": "query", "description": "A string to search the shipments by.", "schema": { "type": "string", "description": "A string to search the shipments by." } }, { "name": "shipment-group-header-status-code", "in": "query", "description": "One or more shipment group header statuses to filter by. Acceptable values include: READY_TO_PACK, READY_TO_SHIP, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, CANCELLED", "schema": { "type": "array", "description": "One or more shipment group header statuses to filter by. Acceptable values include: READY_TO_PACK, READY_TO_SHIP, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, CANCELLED", "items": { "type": "string", "example": "READY_TO_PACK", "enum": [ "READY_TO_PACK", "READY_TO_SHIP", "SHIPPED", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "CANCELLED" ] } }, "example": "READY_TO_PACK" }, { "name": "shipment-group-header-status-class-code", "in": "query", "description": "One or more shipment group header status classification(s) to filter by. Acceptable values include: INCOMPLETE, COMPLETE, CANCELLED", "schema": { "type": "array", "description": "One or more shipment group header status classification(s) to filter by. Acceptable values include: INCOMPLETE, COMPLETE, CANCELLED", "items": { "type": "string", "example": "COMPLETE", "enum": [ "INCOMPLETE", "COMPLETE", "CANCELLED" ] } }, "example": "COMPLETE" }, { "name": "shipment-group-header-number", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a list of shipment group headers successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentGroupHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentGroupHeadersResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/fulfillment-shipment-group-header/{shipment-group-header-id}": { "get": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Get a shipment group header", "operationId": "getShipmentGroupHeader", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-group-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment group header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Get a shipment group header successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentGroupHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_GetShipmentGroupHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/fulfillment-shipment-group-header/{shipment-group-header-id}/fulfillment-shipment-header/{shipment-header-id}": { "delete": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Remove a shipment from shipment group", "operationId": "removeShipmentFromShipmentGroup", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-group-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment group's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Shipment has been removed from the shipment group", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/fulfillment-shipment-batch-header/{shipment-batch-header-id}/fulfillment-shipment-group-header/{shipment-group-header-id}/status": { "post": { "tags": [ "Partner Fulfillment Shipment Batch" ], "description": "Update shipment group header status.", "operationId": "updateShipmentGroupHeaderStatus", "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": "shipment-batch-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment batch header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-group-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment group header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_UpdateShipmentGroupHeaderStatusRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_UpdateShipmentGroupHeaderStatusRequest" } } } }, "responses": { "200": { "description": "Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_UpdateShipmentGroupHeaderStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_UpdateShipmentGroupHeaderStatusResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "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}/fulfillment-shipping-settings": { "get": { "tags": [ "Partner Fulfillment Shipping Settings" ], "description": "Get shipping settings list for a partner", "operationId": "getPartnerFulfillmentShippingSettingsList", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Fulfillment shipping settings list returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_GetPartnerFulfillmentShippingSettingsListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_GetPartnerFulfillmentShippingSettingsListResponse" } } } }, "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 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/{partner-id}/fulfillment-shipping-settings/{fulfillment-shipping-settings-id}": { "get": { "tags": [ "Partner Fulfillment Shipping Settings" ], "description": "Get single shipping settings for a partner", "operationId": "getPartnerFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "fulfillment-shipping-settings-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipping settings' unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Fulfillment shipping settings returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_GetPartnerFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_GetPartnerFulfillmentShippingSettingsResponse" } } } }, "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 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" } } } ] }, "post": { "tags": [ "Partner Fulfillment Shipping Settings" ], "description": "Update individual shipping settings for a partner", "operationId": "updatePartnerFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "fulfillment-shipping-settings-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipping settings' unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UpdatePartnerFulfillmentShippingSettings" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UpdatePartnerFulfillmentShippingSettings" } } } }, "responses": { "201": { "description": "Fulfillment shipping settings updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UpdatePartnerFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UpdatePartnerFulfillmentShippingSettingsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/store/{store-id}/fulfillment-shipping-settings": { "get": { "tags": [ "Partner Store Fulfillment Shipping Settings" ], "description": "Get shipping settings list for a partner store", "operationId": "getPartnerStoreFulfillmentShippingSettingsList", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "store-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The store profile unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Store Fulfillment shipping settings list returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_GetPartnerStoreFulfillmentShippingSettingsListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_GetPartnerStoreFulfillmentShippingSettingsListResponse" } } } }, "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": "Either or both Partner ID, Store 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" } } } ] }, "post": { "tags": [ "Partner Store Fulfillment Shipping Settings" ], "description": "Create individual shipping settings for a partner store", "operationId": "createPartnerStoreFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "store-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The store profile unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_CreatePartnerStoreFulfillmentShippingSettings" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_CreatePartnerStoreFulfillmentShippingSettings" } } } }, "responses": { "201": { "description": "Store Fulfillment shipping settings created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettingsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/store/{store-id}/fulfillment-shipping-settings/{fulfillment-shipping-settings-id}": { "get": { "tags": [ "Partner Store Fulfillment Shipping Settings" ], "description": "Get single shipping settings for a partner store", "operationId": "getPartnerStoreFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "store-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The store profile unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "fulfillment-shipping-settings-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipping settings' unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Store Fulfillment shipping settings returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_GetPartnerStoreFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_GetPartnerStoreFulfillmentShippingSettingsResponse" } } } }, "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": "Either or both Partner ID, Store 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" } } } ] }, "post": { "tags": [ "Partner Store Fulfillment Shipping Settings" ], "description": "Update individual shipping settings for a partner store", "operationId": "updatePartnerStoreFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "store-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The store profile unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "fulfillment-shipping-settings-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipping settings' unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_UpdatePartnerStoreFulfillmentShippingSettings" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_UpdatePartnerStoreFulfillmentShippingSettings" } } } }, "responses": { "200": { "description": "Store Fulfillment shipping settings updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettingsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/style/{style-id}/fulfillment-shipping-settings": { "get": { "tags": [ "Partner Style Fulfillment Shipping Settings" ], "description": "Get shipping settings list for a partner style", "operationId": "getPartnerStyleFulfillmentShippingSettingsList", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "style-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The style listing unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Style Fulfillment shipping settings list returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_GetPartnerStyleFulfillmentShippingSettingsListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_GetPartnerStyleFulfillmentShippingSettingsListResponse" } } } }, "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": "Either or both Partner ID, Style 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" } } } ] }, "post": { "tags": [ "Partner Style Fulfillment Shipping Settings" ], "description": "Create individual shipping settings for a partner style", "operationId": "createPartnerStyleFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "style-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The style listing unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettings" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettings" } } } }, "responses": { "201": { "description": "Style Fulfillment shipping settings created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettingsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/style/{style-id}/fulfillment-shipping-settings/{fulfillment-shipping-settings-id}": { "get": { "tags": [ "Partner Style Fulfillment Shipping Settings" ], "description": "Get single shipping settings for a partner style", "operationId": "getPartnerStyleFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "style-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The style listing unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "fulfillment-shipping-settings-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipping settings' unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Style Fulfillment shipping settings returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_GetPartnerStyleFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_GetPartnerStyleFulfillmentShippingSettingsResponse" } } } }, "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": "Either or both Partner ID, Style 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" } } } ] }, "post": { "tags": [ "Partner Style Fulfillment Shipping Settings" ], "description": "Update individual shipping settings for a partner style", "operationId": "updatePartnerStyleFulfillmentShippingSettings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "style-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The style listing unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "fulfillment-shipping-settings-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The fulfillment shipping settings' unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettings" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettings" } } } }, "responses": { "200": { "description": "Style Fulfillment shipping settings updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettingsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/hyperwallet-authentication-token": { "post": { "tags": [ "Partner Hyperwallet" ], "description": "Create hyperwallet auth token for the partner", "operationId": "createHyperwalletAuthToken", "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": { "200": { "description": "Create hyperwallet auth token for the partner", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_CreateHyperwalletAuthenticationTokenResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_CreateHyperwalletAuthenticationTokenResponse" } } } }, "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": "No hyperwallet auth token obtained for the partner", "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}/hyperwallet-user": { "get": { "tags": [ "Partner Hyperwallet User" ], "description": "Get hyperwallet users associated with the partner", "operationId": "getHyperwalletUsers", "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": { "200": { "description": "All hyperwallet users for the partner", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_GetPartnerHyperwalletUsersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_GetPartnerHyperwalletUsersResponse" } } } }, "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": "No hyperwallet users exist for the partner", "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}/hyperwallet-user/{hyperwallet-user-id}": { "get": { "tags": [ "Partner Hyperwallet User" ], "description": "Get hyperwallet user associated with the partner", "operationId": "getHyperwalletUser", "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": "hyperwallet-user-id", "in": "path", "description": "The hyperwallet user's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "An hyperwallet user for the partner", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_GetPartnerHyperwalletUsersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_GetPartnerHyperwalletUsersResponse" } } } }, "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": "No hyperwallet user exist for the partner", "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 Hyperwallet User" ], "description": "[DONE] Update Hyperwallet user for an authenticated customer.", "operationId": "updateHyperwalletUser", "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": "hyperwallet-user-id", "in": "path", "description": "The hyperwallet user's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_UpdateHyperwalletUserRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_UpdateHyperwalletUserRequest" } } } }, "responses": { "200": { "description": "Hyperwallet user updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletUserService_UpdateHyperwalletUserResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletUserService_UpdateHyperwalletUserResponse" } } } }, "400": { "description": "The request was bad. For instance, user identifier is not correct", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Partner or User 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" } } } ] } }, "/partner/{partner-id}/hyperwallet-user/{hyperwallet-user-id}/hyperwallet-authentication-token": { "post": { "tags": [ "Partner Hyperwallet User" ], "description": "Create hyperwallet user auth token for the partner", "operationId": "createHyperwalletUserAuthToken", "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": "hyperwallet-user-id", "in": "path", "description": "The hyperwallet user's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Create hyperwallet user auth token for the partner", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_CreateHyperwalletUserAuthenticationTokenResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerHyperwalletService_CreateHyperwalletUserAuthenticationTokenResponse" } } } }, "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": "No hyperwallet user auth token obtained for the partner", "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}/installment-billing-schedule": { "post": { "tags": [ "Partner Installment Billing Schedule" ], "description": "Create partner installment billing schedule.", "operationId": "createInstallmentBillingSchedule", "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/PartnerInstallmentBillingService_CreateInstallmentBillingSchedulesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_CreateInstallmentBillingSchedulesRequest" } } } }, "responses": { "200": { "description": "Partner Installment billing schedule created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Installment Billing Schedule" ], "description": "Update partner installment billing schedule.", "operationId": "updateInstallmentBillingSchedule", "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/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesRequest" } } } }, "responses": { "200": { "description": "Partner Installment billing schedule updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesResponse" } } } }, "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}/installment-billing-schedule/style/{style-id}": { "get": { "tags": [ "Partner Installment Billing Schedule" ], "description": "Get partner installment billing schedules history by style.", "operationId": "getInstallmentBillingSchedulesHistoryByStyle", "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": "style-id", "in": "path", "description": "The style's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "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 list from the ordered set. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 } ], "responses": { "200": { "description": "All installment billing schedules for the partner's style", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_GetInstallmentBillingSchedulesByStyleResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_GetInstallmentBillingSchedulesByStyleResponse" } } } }, "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": "Invalid style for the partner", "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}/installment-billing-schedule/{install-billing-schedule-id}": { "get": { "tags": [ "Partner Installment Billing Schedule" ], "description": "Get partner installment billing schedule detail.", "operationId": "getInstallmentBillingScheduleDetail", "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": "install-billing-schedule-id", "in": "path", "description": "The installment billing schedule's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Installment billing schedule detail for the partner", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_GetInstallmentBillingScheduleDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_GetInstallmentBillingScheduleDetailResponse" } } } }, "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": "Invalid installment billing schedule for the partner", "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}/inventory": { "patch": { "tags": [ "Partner Inventory" ], "description": "Update partner drop ship inventory", "operationId": "updateDropShipInventory", "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/PartnerInventoryService_UpdateDropShipInventoryRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_UpdateDropShipInventoryRequest" } } } }, "responses": { "200": { "description": "SKU quantities are updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_UpdateDropShipInventoryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_UpdateDropShipInventoryResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/inventory/{sku-product-id}": { "get": { "tags": [ "Partner Inventory" ], "description": "Get Inventory Adjustment History", "operationId": "getInventoryAdjustmentHistory", "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": "sku-product-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The SKU product ID.", "example": "CTQ203-105" } }, { "name": "audit-history", "in": "query", "schema": { "type": "string", "description": "Indicate whether to return audit-history If not set, returns full audit history. If set to false, returns last history item", "example": "true|false" } }, { "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 history from the ordered set. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 } ], "responses": { "200": { "description": "Partner customer order retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_PartnerInventoryAdjustmentHistoryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_PartnerInventoryAdjustmentHistoryResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/inventory/{inventory-adjustment-id}/detail": { "get": { "tags": [ "Partner Inventory" ], "description": "Get Inventory Adjustment Detail", "operationId": "getInventoryAdjustmentDetail", "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": "inventory-adjustment-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The inventory adjustment ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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 history from the ordered set. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 } ], "responses": { "200": { "description": "Inventory Adjustment Detail retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_PartnerInventoryAdjustmentDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerInventoryService_PartnerInventoryAdjustmentDetailResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/inventory-export": { "get": { "tags": [ "Partner Inventory" ], "description": "Generate inventory details report in CSV or Excel document", "operationId": "getInventoryDetailDocument", "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": "Accept", "in": "header", "required": true, "schema": { "type": "string", "description": "Export document type: application/xlsx|text/csv", "example": "application/xlsx|text/csv" } } ], "responses": { "200": { "description": "Inventory report generated successfully", "content": { "application/octet-stream": { "schema": { "type": "file", "format": "binary" } }, "text/csv": { "schema": { "type": "file", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; 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" } } } }, "404": { "description": "Inventory details not found for the partner", "content": { "application/json; 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" } } } } }, "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}/credit-risk-selection": { "get": { "tags": [ "Partner JewelPay Credit Risk Selection" ], "description": "Get Credit Risk Selections for a Partner", "operationId": "getPartnerJewelPayCreditRiskSelectionList", "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": "service-enrollment-id", "in": "query", "description": "A collection of the desired service enrollment universal unique identifiers", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Credit risk selections returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_GetPartnerJewelPayCreditRiskSelectionListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_GetPartnerJewelPayCreditRiskSelectionListResponse" } } } }, "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 ID or other identifier 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" } } } ] }, "post": { "tags": [ "Partner JewelPay Credit Risk Selection" ], "description": "Create Credit Risk Selection for a Partner", "operationId": "createCreditRiskSelection", "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/PartnerJewelPayCreditRiskService_CreateCreditRiskSelectionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_CreateCreditRiskSelectionRequest" } } } }, "responses": { "201": { "description": "Credit risk selection created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_CreateCreditRiskSelectionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_CreateCreditRiskSelectionResponse" } } } }, "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 ID or other identifier 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}/partner-carrier": { "get": { "tags": [ "Partner Order Carrier" ], "description": "Get partner carriers.", "operationId": "getPartnerCarriers", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "platform-code", "in": "query", "schema": { "type": "string", "description": "The service management platform code.", "example": "JTV_PARTNER_CENTRAL" } } ], "responses": { "200": { "description": "Partner Carriers", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetPartnerCarriersServiceResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetPartnerCarriersServiceResponse" } } } }, "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-id}/order-line": { "get": { "tags": [ "Partner Order" ], "description": "Get order lines.", "operationId": "getOrderLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result set. Min = 1, Max = 1000", "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": "keyword-search", "in": "query", "description": "A string to search the order lines by. Can include sku, style, supplier numbers or title keywords to perform a title search.", "schema": { "type": "string", "description": "A string to search the order lines by. Can include sku, style, supplier numbers or title keywords to perform a title search." } }, { "name": "csv", "in": "query", "description": "Include to force the response to be returned in CSV format", "schema": { "type": "string", "description": "Include to force the response to be returned in CSV format" } }, { "name": "fulfillment-service", "in": "query", "description": "List of fulfillment services to filter the order lines by", "schema": { "maxItems": 25, "minItems": 0, "type": "array", "description": "List of fulfillment services to filter the order lines by", "items": { "type": "string", "description": "List of fulfillment services to filter the order lines by" } } }, { "name": "listing-status", "in": "query", "description": "List of listing statuses to filter the order lines by", "schema": { "maxItems": 25, "minItems": 0, "type": "array", "description": "List of listing statuses to filter the order lines by", "items": { "type": "string", "description": "List of listing statuses to filter the order lines by" } } }, { "name": "product-type", "in": "query", "description": "List of product types to filter the order lines by", "schema": { "maxItems": 25, "minItems": 0, "type": "array", "description": "List of product types to filter the order lines by", "items": { "type": "string", "description": "List of product types to filter the order lines by" } } }, { "name": "Accept", "in": "header", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Order Lines", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderLinesResponse" } }, "text/csv": { "schema": { "type": "string", "example": "Order ID,PCS15K2N7B36,,,,,,\nOrder Number,,,,,,,\nOrder Type,Replenish,,,,,,\nDate Created,04/06/2020,,,,,,\nOrder Name,Example Order CSV Template,,,,,,\nShip From,\"2516 Jane Street, Suite 204, Pittsburgh, PA 15203\",,,,,,\nShip To,\"9600 Parkside Dr, Knoxville, TN 37922\",,,,,,\nTotal SKUs,5,,,,,,\nTotal Units,50,,,,,,\n,,,,,,,\nOrder Line Number,Style Number,SKU Number,SKU Size,Supplier SKU Number,Style Title Description,Quantity,Value\n1,Example Style #,Example SKU #,1,Example Supplier SKU,Example Style Title Description,10,100.00\n2,Example Style #,Example SKU #,10,Example Supplier SKU,Example Style Title Description,10,250.00\n3,Example Style #,Example SKU #,7,Example Supplier SKU,Example Style Title Description,10,1234.00\n4,Example Style #,Example SKU #,8,Example Supplier SKU,Example Style Title Description,10,555.50\n5,Example Style #,Example SKU #,9,Example Supplier SKU,Example Style Title Description,10,0.0" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "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" } } } ] }, "post": { "tags": [ "Partner Order" ], "description": "Create order lines.", "operationId": "createOrderLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderLinesRequest" } } } }, "responses": { "201": { "description": "Order Lines", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderLinesResponse" } } } }, "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 processed because of a conflict in the resource.", "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" } } } ] }, "delete": { "tags": [ "Partner Order" ], "description": "Delete order lines.", "operationId": "deleteOrderLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_DeleteOrderLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_DeleteOrderLinesRequest" } } } }, "responses": { "200": { "description": "Order Lines", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_DeleteOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_DeleteOrderLinesResponse" } } } }, "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 processed because of a conflict in the resource.", "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" } } } ] }, "patch": { "tags": [ "Partner Order" ], "description": "Update order lines.", "operationId": "updateOrderLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLinesRequest" } } } }, "responses": { "200": { "description": "Order Lines", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLinesResponse" } } } }, "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 processed because of a conflict in the resource.", "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": { "get": { "tags": [ "Partner Order" ], "description": "Get partner orders.", "operationId": "getOrderHeaders", "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 identifier (UUID).", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-type", "in": "query", "schema": { "type": "array", "description": "A filter for the types of partner order. valid = PARTNER_REPLENISH_ORDER, PARTNER_REMOVAL_ORDER, PARTNER_REJECT_ORDER", "example": "PARTNER_REPLENISH_ORDER", "items": { "type": "string", "description": "A filter for the types of partner order. valid = PARTNER_REPLENISH_ORDER, PARTNER_REMOVAL_ORDER, PARTNER_REJECT_ORDER", "example": "PARTNER_REPLENISH_ORDER" } } }, { "name": "sort-by", "in": "query", "schema": { "type": "string", "description": "A parameter to control the result set sorting.", "example": "order-date" } }, { "name": "page-size", "in": "query", "schema": { "type": "integer", "description": "The number of records per page of the paged result set. Min = 1, Max = 100, Default = 25", "format": "int32", "example": 10, "default": 25 } }, { "name": "start-index", "in": "query", "schema": { "type": "integer", "description": "The starting index from which to pull orders from the ordered set. Min = 1, Default = 1", "format": "int32", "example": 26, "default": 1 } }, { "name": "keyword-search", "in": "query", "schema": { "type": "string", "description": "A regular expression search string. The search will match against sku number, style number, supplier number, order number and order name.", "example": "red* blue" } }, { "name": "scan-search", "in": "query", "schema": { "type": "string", "description": "A scan search containing an order, shipment or package number to search by." } }, { "name": "start-date", "in": "query", "schema": { "$ref": "#/components/schemas/start-date" } }, { "name": "end-date", "in": "query", "schema": { "$ref": "#/components/schemas/end-date" } }, { "name": "expected-delivery-start-date", "in": "query", "schema": { "$ref": "#/components/schemas/expected-delivery-start-date" } }, { "name": "expected-delivery-end-date", "in": "query", "schema": { "$ref": "#/components/schemas/expected-delivery-end-date" } }, { "name": "order-date-range", "in": "query", "description": "Optional standard minimum order date range code to filter the list of order 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": "expected-delivery-date-range", "in": "query", "description": "Optional standard minimum order expected delivery date range code to filter the list of order 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": "order-status", "in": "query", "schema": { "type": "array", "description": "A collection of the desired order status codes", "example": "SHIPPED", "items": { "type": "string", "description": "A collection of the desired order status codes", "example": "SHIPPED" } } } ], "responses": { "200": { "description": "Successful GET", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderHeadersResponse" } } } }, "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 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" } } } ] }, "post": { "tags": [ "Partner Order" ], "description": "Create order header.", "operationId": "createOrderHeader", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderHeaderRequest" } } } }, "responses": { "201": { "description": "Order header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderHeaderResponse" } } } }, "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 ID or some other aspect of request 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}/order-header/{order-id}": { "get": { "tags": [ "Partner Order" ], "description": "Get details about the specified order.", "operationId": "getOrderDetails", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "add-receipt-info", "in": "query", "description": "Set to 'true' in order to add optional receipt and quality control info to the response", "schema": { "type": "boolean", "description": "Set to 'true' in order to add optional receipt and quality control info to the response", "example": true, "default": false }, "example": true } ], "responses": { "200": { "description": "Partner Order Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderDetailsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderDetailsResponse" } } } }, "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 Order" ], "description": "Update an order header for a partner.", "operationId": "updateOrderHeader", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderRequest" } } } }, "responses": { "200": { "description": "Order header updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderResponse" } } } }, "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 ID or some other aspect of request 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" } } } ] }, "delete": { "tags": [ "Partner Order" ], "description": "WIP Delete an order header for a partner.", "operationId": "deleteOrderHeader", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Order header deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_DeleteOrderHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_DeleteOrderHeaderResponse" } } } }, "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 ID or Order Header 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/{partner-id}/order-header/{order-id}/status": { "post": { "tags": [ "Partner Order" ], "description": "Update a partner's order header status.", "operationId": "updateOrderHeaderStatus", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderStatusRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderStatusRequest" } } } }, "responses": { "200": { "description": "Order header status updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderHeaderStatusResponse" } } } }, "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 ID or some other aspect of request 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}/order-header/{order-id}/shipment-status": { "post": { "tags": [ "Partner Order" ], "description": "Update a partner's order shipment status.", "operationId": "updateOrderShipmentStatus", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderShipmentStatusRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderShipmentStatusRequest" } } } }, "responses": { "200": { "description": "Order shipment status updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderShipmentStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderShipmentStatusResponse" } } } }, "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-id}/order-line-quantity": { "patch": { "tags": [ "Partner Order" ], "description": "Update order line quantities for this order header.", "operationId": "updateOrderLineQuantity", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLineQuantityRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLineQuantityRequest" } } } }, "responses": { "200": { "description": "Update Order Line Quantityh", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLineQuantityResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLineQuantityResponse" } } } }, "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-type": { "get": { "tags": [ "Partner Order Type" ], "description": "Get order types.", "operationId": "getOrderTypes", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Order Types", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderTypesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderTypesResponse" } } } }, "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-type-status": { "get": { "tags": [ "Partner Order Type Status" ], "description": "Get Order Status List by Order Type.", "operationId": "getOrderStatusByOrderType", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "orderType-code", "in": "query", "schema": { "type": "string", "description": "The order type code.", "example": "PARTNER_REPLENISH_ORDER" } } ], "responses": { "200": { "description": "Order Type Order Statuses", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderTypeOrderStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderTypeOrderStatusResponse" } } } }, "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}/subscriber-subscription/{subscriber-subscription-id}": { "get": { "tags": [ "Partner Order Subscriber Subscription" ], "description": "Get partner subscriber subscription for a partner order by subscriber subscription id", "operationId": "getPartnerSubscriberSubscriptionByUuid", "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": "subscriber-subscription-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique subscriber subscription id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner subscriber subscription deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetOrderSubscriberSubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetOrderSubscriberSubscriptionResponse" } } } }, "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 Order Subscriber Subscription" ], "description": "Deactivate partner subscriber subscription", "operationId": "deleteOrderSubscriberSubscription", "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": "subscriber-subscription-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique subscriber subscription id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner subscriber subscription deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_DeleteOrderSubscriberSubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_DeleteOrderSubscriberSubscriptionResponse" } } } }, "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}/order-header/{order-header-id}/subscriber-subscription": { "get": { "tags": [ "Partner Order Subscriber Subscription" ], "description": "Get subscriber subscription list for a partner order.", "operationId": "getOrderSubscriberSubscriptions", "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" } } ], "responses": { "200": { "description": "Partner Order Subscriber Subscriptions", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionsResponse" } } } }, "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 Order Subscriber Subscription" ], "description": "Create partner order subscriber subscription", "operationId": "createPartnerOrderSubscriberSubscription", "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" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_CreateOrderSubscriberSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_CreateOrderSubscriberSubscriptionRequest" } } } }, "responses": { "201": { "description": "Create partner order subscriber subscription response", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_CreateOrderSubscriberSubscriptionInteractionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_CreateOrderSubscriberSubscriptionInteractionResponse" } } } }, "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" } } } }, "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}/packing-slip": { "post": { "tags": [ "Partner Packing Slip" ], "description": "Get the partner's packing slips", "operationId": "generatePartnerPackingSlips", "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/PartnerPackingSlipService_partnerPackingSlipRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_partnerPackingSlipRequest" } } }, "required": true }, "responses": { "200": { "description": "PDF of Packing Slips returned successfully", "content": { "application/pdf": { "schema": { "type": "file", "format": "binary" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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/PartnerPackingSlipErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipErrorResponse" } } } } }, "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}/pack-slip": { "get": { "tags": [ "Partner Packing Slip" ], "description": "Get a list of packing slip creation jobs requested by the partner associate", "operationId": "getPackingSlipStatusList", "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": "partner-associate-id", "in": "query", "description": "Filter by the associate that created the packing slip", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "pack-slip-status", "in": "query", "description": "One or more packing slip statuses to filter by. Acceptable values include: PENDING, IN_PROGRESS, CREATED, FAILED", "schema": { "type": "array", "description": "One or more job statuses to filter by. Acceptable values include: PENDING, IN_PROGRESS, CREATED, FAILED", "items": { "type": "string", "example": "CREATED", "enum": [ "PENDING", "IN_PROGRESS", "CREATED", "FAILED", "PENDING", "IN_PROGRESS", "CREATED", "FAILED" ] } }, "example": "CREATED" }, { "name": "creation-date", "in": "query", "description": "Filter by the creation date of the packing slip", "example": "10/01/2021", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Packing slip job returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerPackSlipStatusListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerPackSlipStatusListResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Packing Slip" ], "description": "Create a request to generate a packing slip via batch job", "operationId": "createPartnerPackingSlipJob", "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/PartnerPackingSlipJobService_createPartnerPackSlipRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipJobService_createPartnerPackSlipRequest" } } }, "required": true }, "responses": { "201": { "description": "Packing slip generation started successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_CreatePartnerPackSlipResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_CreatePartnerPackSlipResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/pack-slip/{pack-slip-id}/document": { "get": { "tags": [ "Partner Packing Slip" ], "description": "Get the partner's packing slip created by batch job", "operationId": "getPackingSlipDocument", "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": "pack-slip-id", "in": "path", "description": "The packing slip's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "PDF of the packing slip returned successfully", "content": { "application/pdf": { "schema": { "type": "file", "format": "binary" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/pack-slip/{pack-slip-id}": { "get": { "tags": [ "Partner Packing Slip" ], "description": "Get the partner's packing slip job", "operationId": "getPackingSlipStatusById", "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": "pack-slip-id", "in": "path", "description": "The packing slip's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Packing slip job returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerPackSlipStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerPackSlipStatusResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/patriot-act-questionnaire/{questionnaire-id}/answers": { "get": { "tags": [ "Partner Patriot Act Questionnaire" ], "description": "Get Partner Patriot Act Questionnaire Answers.", "operationId": "getPartnerPatriotActAnswers", "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": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "service-code", "in": "query", "schema": { "type": "string", "description": "The Patriot Act Answers for this partner's service code", "example": "CONSIGNMENT" } } ], "responses": { "200": { "description": "Get Partner Patriot Act Questionaire Answers", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_GetPartnerPatriotActQuestionnaireAnswersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_GetPartnerPatriotActQuestionnaireAnswersResponse" } } } }, "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 Patriot Act Questionnaire" ], "description": "Create Partner Patriot Act Questionnaire Answers.", "operationId": "setPartnerPatriotActAnswers", "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": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_PatriotActQuestionnaireAnswersRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_PatriotActQuestionnaireAnswersRequest" } } } }, "responses": { "201": { "description": "Set Partner Patriot Act Questionaire Answers", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_CreatePartnerPatriotActQuestionnaireAnswersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_CreatePartnerPatriotActQuestionnaireAnswersResponse" } } } }, "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}/patriot-act-questionnaire": { "get": { "tags": [ "Partner Patriot Act Questionnaire" ], "description": "Get Partner Patriot Act Questionnaire.", "operationId": "getPartnerPatriotActQuestionnaire", "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": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Get Partner Patriot Act Questionaire", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_PartnerPatriotActQuestionnaireResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_PartnerPatriotActQuestionnaireResponse" } } } }, "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}/patriot-act-questionnaire/{questionnaire-id}": { "get": { "tags": [ "Partner Patriot Act Questionnaire" ], "description": "Get Partner Patriot Act Questionnaire by Questionnaire ID.", "operationId": "getPartnerPatriotActQuestionnaireById", "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": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "questionnaire-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Patriot Act Questionnaire Unique Resource Identifier", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Get Partner Patriot Act Questionaire By ID", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_PartnerPatriotActQuestionnaireResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_PartnerPatriotActQuestionnaireResponse" } } } }, "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}/patriot-act-questionnaire/{questionnaire-id}/answers/{answer-id}": { "get": { "tags": [ "Partner Patriot Act Questionnaire" ], "description": "Get Partner Patriot Act Questionnaire Answers by Answers ID.", "operationId": "getPartnerPatriotActAnswersByResourceId", "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": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "answer-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The Patriot Act Answers Unique Resource Identifier", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Get Partner Patriot Act Questionaire Answers By ID", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_GetPartnerPatriotActQuestionnaireAnswersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPatriotActService_GetPartnerPatriotActQuestionnaireAnswersResponse" } } } }, "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-pricing-offer": { "get": { "tags": [ "Partner Pricing Offer" ], "description": "Get the partner pricing offers", "operationId": "getPricingOffers", "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": "price-offer-type-code", "in": "query", "description": "The list of optional price offer type code to filter on.", "schema": { "type": "array", "items": { "type": "string" } }, "example": "BASE_PRICING" } ], "responses": { "200": { "description": "Partner price offers fetched successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetPricingOfferResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetPricingOfferResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/pricing-offer-schedule": { "post": { "tags": [ "Partner Pricing Offer Schedule" ], "description": "Batch create discount price offer schedules", "operationId": "createBatchDiscountPricingOfferSchedules", "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/PartnerProductLabelService_CreateBatchDiscountPriceSchedulesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProductLabelService_CreateBatchDiscountPriceSchedulesRequest" } } }, "required": true }, "responses": { "200": { "description": "Batch create discount price offer schedules successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_CreateBatchDiscountPriceSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_CreateBatchDiscountPriceSchedulesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "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 processed because of a conflict in the resource.", "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" } } } ] }, "patch": { "tags": [ "Partner Pricing Offer Schedule" ], "description": "Batch update price offer schedules", "operationId": "updateBatchPricingOfferSchedules", "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/PartnerProductLabelService_UpdateBatchPriceSchedulesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProductLabelService_UpdateBatchPriceSchedulesRequest" } } }, "required": true }, "responses": { "200": { "description": "Updated price offer schedule batch successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_UpdateBatchPriceSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_UpdateBatchPriceSchedulesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/style/{style-listing-id}/pricing-offer-execution": { "get": { "tags": [ "Partner Product Pricing Offer Execution" ], "description": "Get the partner product pricing offer execution schedule history", "operationId": "getProductPricingOfferExecutionScheduleHistoryByStyle", "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": "style-listing-id", "in": "path", "description": "The style listing id to filter the pricing execution schedule history on.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result list. 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 from the result list. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 }, { "name": "priceExecutionMinPrice", "in": "query", "schema": { "type": "number", "description": "The price execution min price" } }, { "name": "priceExecutionMaxPrice", "in": "query", "schema": { "type": "number", "description": "The price execution max price" } }, { "name": "standardDateRange", "in": "query", "description": "Optional standard date range code to filter the list of pricing offer schedules", "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" ] }, "example": "TODAY" }, { "name": "customStartDate", "in": "query", "description": "The price offer schedule start date start of the custom range", "example": "11/01/2048", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, { "name": "customEndDate", "in": "query", "description": "The price offer schedule start date end of the custom range", "example": "01/01/2088", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, { "name": "priceOfferLabelCode", "in": "query", "description": "The list of optional price offer label code to filter on.", "schema": { "type": "array", "items": { "type": "string" } }, "example": "BASE_PRICE" } ], "responses": { "200": { "description": "Partner product pricing offer execution schedule history fetched successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetPricingOfferExecutionScheduleHistoryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetPricingOfferExecutionScheduleHistoryResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/style/{style-listing-id}/pricing-offer-schedule": { "get": { "tags": [ "Partner Product Pricing Offer Schedule" ], "description": "Get the partner product pricing offer schedules", "operationId": "getProductPricingOfferSchedulesByStyle", "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": "style-listing-id", "in": "path", "description": "The style listing id to filter the schedules on.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "page-size", "in": "query", "description": "The number of records per page of the paged result list. 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 from the result list. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 26 }, { "name": "priceOfferMinPrice", "in": "query", "description": "The optional price offer min price.", "schema": { "type": "number" }, "example": 10.0 }, { "name": "priceOfferMaxPrice", "in": "query", "description": "The optional price offer max price.", "schema": { "type": "number" }, "example": 100.0 }, { "name": "priceOfferLabelCode", "in": "query", "description": "The optional - Query Parameter used to allow the client to filter the list of Price Offer Schedules by Price Offer Label. ", "schema": { "type": "array", "items": { "type": "string" } }, "example": "BASE_PRICE" }, { "name": "standardDateRange", "in": "query", "description": "Optional standard date range code to filter the list of pricing offer schedules", "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" ] }, "example": "TODAY" }, { "name": "customStartDate", "in": "query", "description": "The price offer schedule start date start of the custom range", "example": "11/01/2048", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, { "name": "customEndDate", "in": "query", "description": "The price offer schedule start date end of the custom range", "example": "01/01/2088", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } } ], "responses": { "200": { "description": "Partner product pricing offer schedules fetched successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetProductPricingOfferSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetProductPricingOfferSchedulesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/style/{style-listing-id}/pricing-offer-schedule/{schedule-id}": { "get": { "tags": [ "Partner Product Pricing Offer Schedule" ], "description": "Get the partner product pricing offer schedules detail.", "operationId": "getProductPricingOfferSchedulesByStyleDetail", "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": "style-listing-id", "in": "path", "description": "The style listing id to filter the schedules on.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "schedule-id", "in": "path", "description": "The Style Price Schedule Id must be a valid uuid.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner product pricing offer schedules detail fetched successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetProductPricingOfferScheduleDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPricingOfferService_GetProductPricingOfferScheduleDetailResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/style/{style-listing-id}/pricing-offer-schedule/{price-schedule-id}": { "delete": { "tags": [ "Partner Product Pricing Offer Schedule" ], "description": "Delete style price offer schedule.", "operationId": "deleteProductPricingOfferScheduleById", "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": "style-listing-id", "in": "path", "description": "The style listing id to filter the schedules on.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "price-schedule-id", "in": "path", "description": "The id of the price offer schedule", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Deleted style price offer schedule successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/product-label": { "post": { "tags": [ "Partner Product Labels" ], "description": "Get the partner's product sku labels", "operationId": "generatePartnerProductLabels", "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/PartnerProductLabelService_partnerProductLabelRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProductLabelService_partnerProductLabelRequest" } } }, "required": true }, "responses": { "200": { "description": "PDF of Sku Labels returned successfully" }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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/PartnerProductLabelErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProductLabelErrorResponse" } } } } }, "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}/style-listing/{style-listing-id}/style-label-schedule/{label-schedule-id}": { "get": { "tags": [ "Partner Listings" ], "description": "Get listing label schedule details", "operationId": "getListingLabelScheduleDetail", "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": "style-listing-id", "in": "path", "description": "The listing style's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "label-schedule-id", "in": "path", "description": "The label schedule's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Partner Listing label schedule details retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerListingLabelScheduleDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerListingLabelScheduleDetailResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Listings" ], "description": "Delete listing label schedule.", "operationId": "deleteListingLabelSchedule", "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": "style-listing-id", "in": "path", "description": "The listing style's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "label-schedule-id", "in": "path", "description": "The label schedule's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Partner Listing label schedule detail deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_DeletePartnerListingLabelScheduleResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_DeletePartnerListingLabelScheduleResponse" } } } }, "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}/style-listing/{style-listing-id}/style-label-schedule": { "get": { "tags": [ "Partner Listings" ], "description": "Get listing label schedule list", "operationId": "getListingLabelScheduleList", "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": "style-listing-id", "in": "path", "description": "The listing style's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "page-size", "in": "query", "description": "The number of label schedule 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 label schedule. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "label-code", "in": "query", "description": "Listing label code for filtering schedules", "schema": { "type": "array", "description": "Listing label code for filtering schedules", "items": { "type": "string", "description": "Listing label code for filtering schedules", "enum": [ "NEW_ARRIVAL", "BEST_SELLERS", "TOP_RATED", "CURATORS_PICK", "MOST_WISHED_FOR", "TRENDING", "NEW_MARKDOWNS", "ONE_OF_A_KIND", "JEDORA_EXCLUSIVE", "BLACK_FRIDAY_DEALS", "CYBER_DEAL", "DOORBUSTERS" ] }, "enum": [ "NEW_ARRIVAL", "BEST_SELLERS", "TOP_RATED", "CURATORS_PICK", "MOST_WISHED_FOR", "TRENDING", "NEW_MARKDOWNS", "ONE_OF_A_KIND", "JEDORA_EXCLUSIVE", "BLACK_FRIDAY_DEALS", "CYBER_DEAL", "DOORBUSTERS" ] }, "example": "NEW_ARRIVAL" }, { "name": "custom-start-date", "in": "query", "description": "The inclusive starting filter for schedule start date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "custom-end-date", "in": "query", "description": "The inclusive ending filter for schedule start date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "standard-date-range-code", "in": "query", "description": "Optional standard date range code to filter the list of schedules by schedule start date", "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" } ], "responses": { "200": { "description": "Partner Listing label schedule list retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerListingLabelScheduleListResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerListingLabelScheduleListResponse" } } } }, "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}/style-listing/style-label-schedule": { "post": { "tags": [ "Partner Listings" ], "description": "Create listing label schedules", "operationId": "createListingLabelSchedules", "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/PartnerListingService_CreateListingLabelSchedulesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreateListingLabelSchedulesRequest" } } } }, "responses": { "201": { "description": "Partner Listing label schedules created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_PartnerListingLabelSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_PartnerListingLabelSchedulesResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Listings" ], "description": "Update listing label schedules", "operationId": "updateListingLabelSchedules", "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/PartnerListingService_UpdateListingLabelSchedulesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_UpdateListingLabelSchedulesRequest" } } } }, "responses": { "200": { "description": "Partner Listing label schedules updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_PartnerListingLabelSchedulesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_PartnerListingLabelSchedulesResponse" } } } }, "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}/product-listing": { "get": { "tags": [ "Partner Listings" ], "description": "Get the partner's product listing headers", "operationId": "getPartnerProductListing", "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": "service", "in": "query", "description": "The code of the enrolled listing service to filter listings on. Can provide one or more values.", "required": true, "schema": { "type": "array", "description": "The code of the enrolled listing service to filter listings on. Can provide one or more values.", "items": { "type": "string", "example": "JTV_CONSIGNMENT" } }, "example": "JTV_CONSIGNMENT" }, { "name": "fulfillment-service", "in": "query", "description": "The code of the enrolled fulfillment service to filter listings on. Can provide one or more values.", "schema": { "type": "array", "description": "The code of the enrolled fulfillment service to filter listings on. Can provide one or more values.", "items": { "type": "string", "example": "JTV_CONSIGNMENT" } }, "example": "JTV_CONSIGNMENT" }, { "name": "order-id", "in": "query", "description": "To retrieve additional order info with listings, add an order's unique uuid", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "shop-profile-id", "in": "query", "description": "To pull listings for a specific partner Shop Profile, provide the profile's unique uuid", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-number", "in": "query", "description": "The specific style number you would like to return", "schema": { "type": "string" } }, { "name": "sku-number", "in": "query", "description": "The specific SKU number you would like to return", "schema": { "type": "string" } }, { "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": "listing-status", "in": "query", "description": "One or more listing statuses to filter by. Acceptable values include: PENDING_ACTIVATION, INCOMPLETE, APPROVAL_REQUIRED, OUT_OF_STOCK, ON_HOLD, CLOSED, ERROR, ACTIVE, PRICING_ISSUE, REJECTED", "schema": { "type": "array", "description": "One or more listing statuses to filter by. Acceptable values include: PENDING_ACTIVATION, INCOMPLETE, APPROVAL_REQUIRED, OUT_OF_STOCK, ON_HOLD, CLOSED, ERROR, ACTIVE, PRICING_ISSUE, REJECTED", "items": { "type": "string", "example": "PENDING_ACTIVATION", "enum": [ "PENDING_ACTIVATION", "INCOMPLETE", "APPROVAL_REQUIRED", "OUT_OF_STOCK", "ON_HOLD", "CLOSED", "ERROR", "ACTIVE", "PRICING_ISSUE", "REJECTED" ] } }, "example": "PENDING_ACTIVATION" }, { "name": "pricing-status", "in": "query", "description": "One or more pricing statuses to filter by. Acceptable values include: PENDING_REVIEW, ACCEPTED, REJECTED, EXPIRED, CANCELLED, NONE_SUBMITTED", "schema": { "type": "array", "description": "One or more pricing statuses to filter by. Acceptable values include: PENDING_REVIEW, ACCEPTED, REJECTED, EXPIRED, CANCELLED, NONE_SUBMITTED", "items": { "type": "string", "example": "REJECTED", "enum": [ "PENDING_REVIEW", "ACCEPTED", "REJECTED", "EXPIRED", "CANCELLED", "NONE_SUBMITTED" ] } }, "example": "REJECTED" }, { "name": "product-type", "in": "query", "description": "One or more product types to filter by. For example: Ring", "schema": { "type": "array", "description": "One or more product types to filter by. For example: Ring", "items": { "type": "string", "example": "Ring" } }, "example": "Ring" }, { "name": "customer-rating", "in": "query", "description": "One or more customer rating ranges to filter by. Acceptable values include: 0, 1, 2, 3, 4, 5", "schema": { "type": "array", "description": "One or more customer rating ranges to filter by. Acceptable values include: 0, 1, 2, 3, 4, 5", "items": { "type": "integer", "format": "int32", "example": 4, "enum": [ 0, 1, 2, 3, 4, 5 ] } }, "example": 4 }, { "name": "listing-status-class", "in": "query", "description": "The listing status classification to filter by. Acceptable values include: all, active, inactive", "schema": { "type": "string", "description": "The listing status classification to filter by. Acceptable values include: all, active, inactive", "example": "active", "enum": [ "all", "active", "inactive" ] }, "example": "active" }, { "name": "keyword-search", "in": "query", "description": "A string to search the listings by. Can include sku, style, product, supplier numbers or keywords to perform a title search.", "schema": { "type": "string", "description": "A string to search the listings by. Can include sku, style, product, supplier numbers or keywords to perform a title search." } }, { "name": "sort-attribute", "in": "query", "description": "The attribute to sort listings by", "schema": { "type": "string", "description": "The attribute to sort listings by. Acceptable values include: CREATION_DATE_ASC, CREATION_DATE_DESC, SUPPLIER_PRICE_ASC, SUPPLIER_PRICE_DESC, SELLING_PRICE_ASC, SELLING_PRICE_DESC, AVAILABLE_QUANTITY_ASC, AVAILABLE_QUANTITY_DESC", "example": "CREATION_DATE_ASC", "enum": [ "CREATION_DATE_ASC", "CREATION_DATE_DESC", "SUPPLIER_PRICE_ASC", "SUPPLIER_PRICE_DESC", "SELLING_PRICE_ASC", "SELLING_PRICE_DESC", "AVAILABLE_QUANTITY_ASC", "AVAILABLE_QUANTITY_DESC", "CREATION_DATE_ASC", "CREATION_DATE_DESC", "SUPPLIER_PRICE_ASC", "SUPPLIER_PRICE_DESC", "SELLING_PRICE_ASC", "SELLING_PRICE_DESC", "AVAILABLE_QUANTITY_ASC", "AVAILABLE_QUANTITY_DESC" ] }, "example": "CREATION_DATE_ASC" }, { "name": "installment-billing-terms", "in": "query", "description": "List of installment billing terms, it may be 0, 1, or more Installment Billing Terms codes.", "schema": { "type": "array", "description": "List of installment billing terms, it may be 0, 1, or more Installment Billing Terms codes.", "example": "3_PAYMENTS", "items": { "type": "string", "description": "List of installment billing terms, it may be 0, 1, or more Installment Billing Terms codes.", "example": "3_PAYMENTS" } }, "example": "3_PAYMENTS" }, { "name": "price-offer-code", "in": "query", "description": "List of pricing offer label codes, it may be 0, 1, or more Price Offer Label codes.", "schema": { "type": "array", "description": "List of pricing offer label codes, it may be 0, 1, or more Price Offer Label codes.", "example": "CLEARANCE_PRICE", "items": { "type": "string", "description": "List of pricing offer label codes, it may be 0, 1, or more Price Offer Label codes.", "example": "CLEARANCE_PRICE" } }, "example": "CLEARANCE_PRICE" }, { "name": "listing-label-codes", "in": "query", "description": "List of listing label codes, it may be 0, 1, or more Listing Label codes.", "schema": { "type": "array", "description": "List of listing label codes, it may be 0, 1, or more Listing Label codes.", "example": "CYBER_DEAL", "items": { "type": "string", "description": "List of listing label codes, it may be 0, 1, or more Listing Label codes.", "example": "CYBER_DEAL" } }, "example": "CYBER_DEAL" } ], "responses": { "200": { "description": "Listings returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerProductListingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerProductListingsResponse" } } } }, "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}/product-listing/{listing-id}/style/{style-listing-id}/media-upload-uri": { "post": { "tags": [ "Partner Listings" ], "description": "Create a media upload URI for a listing's style.", "operationId": "createPartnerStyleMediaUploadUri", "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": "listing-id", "in": "path", "description": "The product listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-listing-id", "in": "path", "description": "The style listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerShopProfileMediaUploadUriRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerShopProfileMediaUploadUriRequest" } } } }, "responses": { "201": { "description": "Partner Listing Style Upload URI created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerStyleMediaUploadUriResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerStyleMediaUploadUriResponse" } } } }, "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}/product-listing/{listing-id}/style/{style-listing-id}/media": { "get": { "tags": [ "Partner Listings" ], "description": "Get the list of media items for a style by its listing.", "operationId": "getPartnerStyleMedia", "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": "listing-id", "in": "path", "description": "The product listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-listing-id", "in": "path", "description": "The style listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Listing Style Media items fetched successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerStyleMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_GetPartnerStyleMediaResponse" } } } }, "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 Listings" ], "description": "Create media for a listing's style.", "operationId": "createPartnerStyleMedia", "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": "listing-id", "in": "path", "description": "The product listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-listing-id", "in": "path", "description": "The style listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerStyleMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerStyleMediaRequest" } } } }, "responses": { "201": { "description": "Partner Listing Style Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerStyleMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_CreatePartnerStyleMediaResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Listings" ], "description": "Update media for a listing's style.", "operationId": "updatePartnerStyleMedia", "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": "listing-id", "in": "path", "description": "The product listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-listing-id", "in": "path", "description": "The style listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_UpdatePartnerStyleMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_UpdatePartnerStyleMediaRequest" } } } }, "responses": { "200": { "description": "Partner Listing Style Media updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_UpdatePartnerStyleMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_UpdatePartnerStyleMediaResponse" } } } }, "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}/product-listing/{listing-id}/style/{style-listing-id}/media/{media-id}": { "delete": { "tags": [ "Partner Listings" ], "description": "Delete a media item from a style.", "operationId": "deletePartnerStyleMedia", "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": "listing-id", "in": "path", "description": "The product listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "style-listing-id", "in": "path", "description": "The style listing's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "media-id", "in": "path", "description": "The media asset's unique universal identifier.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Listing Style Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_DeletePartnerStyleMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerListingService_DeletePartnerStyleMediaResponse" } } } }, "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" } } } ] } }, "/associate-invite-token-info/{invite-token}": { "get": { "tags": [ "Partner Associate" ], "description": "Get the email address associated with the token, if the token is valid.", "operationId": "getPartnerAssociateInvitationTokenInfo", "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": "invite-token", "in": "path", "description": "Partner associate's invitation token.", "required": true, "schema": { "type": "string" }, "example": "eyJraWQiOiIxMGU5MzIxYi0wY2Y0LTQ2Y2YtYTAyMi04Y2I1MDA5YzU5OTEiLCJhbGciOiJIUzM4NCJ9.eyJpc3MiOiJKVFYiLCJpYXQiOjE1NTcxNTcwNTcsImV4cCI6MTU1NzE1ODI1Nywic3ViIjoiNjQxOGE2ZjItOGE2NS00YWQxLTg3ZDgtN2M2ZmExZGIxYWY3IiwicGFydG5lci11dWlkIjoiMTBkZmQ2OGEtOGIxOS00MzA1LTgzMzEtNmQzMGMyOGE1MmVmIn0.cCGTJBsLQNdGuAWgErtzUv2EVnYkp7YOOmp4wY86jIPwGXk0utB2A8_FleywP4L3" } ], "responses": { "200": { "description": "The invite token is valid.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetAssociateInviteTokenInfoResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetAssociateInviteTokenInfoResponse" } } } }, "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-invite": { "get": { "tags": [ "Partner" ], "description": "Get list of partner invites", "operationId": "getPartnerInviteList", "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 = 1000", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "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 partner invite 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 partner invite 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": "filter", "in": "query", "description": "Filter text to apply to partner invite history search. Will apply to firstName, lastName, email or LegalEntityName.", "schema": { "type": "string" }, "example": "ROXY GEMS" }, { "name": "partner-invite-state", "in": "query", "description": "The partner invite state [PENDING,ACCEPTED,EXPIRED,CANCELLED]. If provided the API will only return partner invites that match the given status.", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerInvitesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerInvitesResponse" } } } }, "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" ], "description": "Create or resend partner invite", "operationId": "createPartnerInvite", "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/PartnerProfileService_CreatePartnerInviteRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerInviteRequest" } } } }, "responses": { "201": { "description": "Invite Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerInviteResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerInviteResponse" } } } }, "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": "Partner with same legal name already registered.", "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-invite/{invite-id}": { "get": { "tags": [ "Partner" ], "description": "Get partner invite by invite ID", "operationId": "getPartnerInviteByUUID", "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": "invite-id", "in": "path", "description": "The unique universal identifier associated with partner invitation.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Request Was Successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerInviteByUUIDResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerInviteByUUIDResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner" ], "description": "Cancel partner invitation", "operationId": "deletePartnerInvite", "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": "invite-id", "in": "path", "description": "The unique universal identifier associated with partner invitation.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "Partner Invitation cancelled successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerInviteResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerInviteResponse" } } } }, "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-invite-token-info/{invite-token}": { "get": { "tags": [ "Partner" ], "description": "Get the email address associated with the token, if the token is valid.", "operationId": "getPartnerInvitationTokenInfo", "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": "invite-token", "in": "path", "description": "Partner invitation token.", "required": true, "schema": { "type": "string" }, "example": "eyJraWQiOiIxMGU5MzIxYi0wY2Y0LTQ2Y2YtYTAyMi04Y2I1MDA5YzU5OTEiLCJhbGciOiJIUzM4NCJ9.eyJpc3MiOiJKVFYiLCJpYXQiOjE1NTcxNTcwNTcsImV4cCI6MTU1NzE1ODI1Nywic3ViIjoiNjQxOGE2ZjItOGE2NS00YWQxLTg3ZDgtN2M2ZmExZGIxYWY3IiwicGFydG5lci11dWlkIjoiMTBkZmQ2OGEtOGIxOS00MzA1LTgzMzEtNmQzMGMyOGE1MmVmIn0.cCGTJBsLQNdGuAWgErtzUv2EVnYkp7YOOmp4wY86jIPwGXk0utB2A8_FleywP4L3" } ], "responses": { "200": { "description": "The invite token is valid.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerInviteTokenInfoResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerInviteTokenInfoResponse" } } } }, "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": { "get": { "tags": [ "Partner" ], "description": "Get partner profile list associated with the authenticated user.", "operationId": "getPartnerProfiles", "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": "pending-pricing-only", "in": "query", "description": "Used to restrict the list of partners to only those with pending pricing proposals", "schema": { "type": "boolean" }, "example": true }, { "name": "filter-operating-name", "in": "query", "description": "Used to filter by Partner Operating Name", "schema": { "type": "string" }, "example": "Test" }, { "name": "scan-search", "in": "query", "description": "Used by employees to find a partner via an order, shipment or package scan", "schema": { "type": "string" } }, { "name": "recent-partners-uuids", "in": "query", "description": "Used to order the Recent Partners", "schema": { "type": "array", "items": { "type": "string" } }, "example": "856ea0f3-4936-4654-8d89-c2a2dac277ba" }, { "name": "page-size", "in": "query", "description": "The number of partner records per page of the paged result set. Min = 1.", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 }, { "name": "start-index", "in": "query", "description": "The starting index from which to pull partners from the ordered set. Min = 1", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 11 } ], "responses": { "200": { "description": "Partner Profiles", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerProfilesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerProfilesResponse" } } } }, "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" ], "description": "Create an enterprise partner profile for the current authenticated user.", "operationId": "createPartner", "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/PartnerProfileService_CreatePartnerProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerProfileRequest" } } } }, "responses": { "201": { "description": "Profile Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerResponse" } } } }, "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}": { "get": { "tags": [ "Partner" ], "description": "Get enterprise partner profile.", "operationId": "getPartnerProfile", "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": { "200": { "description": "Partner Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerResponse" } } } }, "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" ], "description": "Update enterprise partner profile", "operationId": "updatePartner", "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/PartnerProfileService_UpdatePartnerRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerRequest" } } } }, "responses": { "200": { "description": "Profile Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerResponse" } } } }, "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}/site/{site-id}": { "get": { "tags": [ "Partner" ], "description": "Get enterprise partner site for an site id.", "operationId": "getPartnerSite", "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": "site-id", "in": "path", "description": "The partner site's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Site Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerSiteResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerSiteResponse" } } } }, "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" ], "description": "Update partner site", "operationId": "updatePartnerSite", "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": "site-id", "in": "path", "description": "The partner site'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/PartnerProfileService_UpdatePartnerSiteRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerSiteRequest" } } } }, "responses": { "303": { "description": "Redirect to get the updated site or new site that replace the input site", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerSiteResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerSiteResponse" } } } }, "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" ], "description": "Delete partner site", "operationId": "deletePartnerSite", "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": "site-id", "in": "path", "description": "The partner site's unique universal id.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner Site deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerSiteResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerSiteResponse" } } } }, "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}/site": { "get": { "tags": [ "Partner" ], "description": "Get partner sites list for a partner.", "operationId": "getPartnerSites", "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": "active", "in": "query", "schema": { "type": "string", "description": "Indicate whether to return active or inactive sites. If not set, return both active and inactive sties are returned", "example": "true|false" } }, { "name": "sort-attribute", "in": "query", "schema": { "type": "string", "description": "The attribute to sort sites by", "example": "CREATION_DATE_DESC", "enum": [ "CREATION_DATE_ASC", "CREATION_DATE_DESC" ] } } ], "responses": { "200": { "description": "Partner Sites", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerSitesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerSitesResponse" } } } }, "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" ], "description": "Create enterprise partner site", "operationId": "createPartnerSite", "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/PartnerProfileService_CreatePartnerSiteRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerSiteRequest" } } } }, "responses": { "201": { "description": "Site Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerSiteResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerSiteResponse" } } } }, "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}/receipt-header": { "get": { "tags": [ "Partner Receipt" ], "description": "Get a list of the partner's receipt headers", "operationId": "getPartnerReceiptHeaders", "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": 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": "keyword-search", "in": "query", "description": "A string to search the receipts by. Can include sku, style, supplier SKU/style numbers, receipt number or shipment number keywords to perform a search.", "schema": { "type": "string", "description": "A string to search the receipts by. Can include sku, style, supplier SKU/style numbers, receipt number or shipment number keywords to perform a search." } }, { "name": "created-date-range", "in": "query", "description": "Optional standard created date range code to filter the list of receipt 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" ] }, "example": "TODAY" }, { "name": "created-start-date", "in": "query", "description": "The inclusive starting filter by created date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "created-end-date", "in": "query", "description": "The inclusive ending filter by created date. Format: 2001-07-04T12:08:56.235-07:00", "schema": { "$ref": "#/components/schemas/DateType" }, "example": "2001-07-04T12:08:56.235-07:00" }, { "name": "receipt-status", "in": "query", "description": "One or more receipt statuses to filter by. Acceptable values include: PENDING_CONFIRMATION, CONFIRMED, COMPLETED, CANCELLED, PENDING_REFUND", "schema": { "type": "array", "description": "One or more receipt statuses to filter by. Acceptable values include: PENDING_CONFIRMATION, CONFIRMED, COMPLETED, CANCELLED, PENDING_REFUND", "items": { "type": "string", "example": "CONFIRMED", "enum": [ "PENDING_CONFIRMATION", "CONFIRMED", "COMPLETED", "CANCELLED", "PENDING_REFUND" ] } }, "example": "PENDING_CONFIRMATION" }, { "name": "receipt-status-class", "in": "query", "description": "One or more receipt classification statuses to filter by. Acceptable values include: INCOMPLETE, COMPLETE, CANCELLED", "schema": { "type": "array", "description": "One or more receipt classification statuses to filter by. Acceptable values include: INCOMPLETE, COMPLETE, CANCELLED", "items": { "type": "string", "example": "COMPLETE", "enum": [ "INCOMPLETE", "COMPLETE", "CANCELLED" ] } }, "example": "INCOMPLETE" }, { "name": "shipment-id", "in": "query", "description": "The unique UUID of the shipment to filter by", "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Get receipt header list successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptHeadersResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Receipt" ], "description": "Create partner receipt header", "operationId": "createPartnerReceiptHeader", "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/PartnerReceiptService_CreatePartnerReceiptHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreatePartnerReceiptHeaderRequest" } } } }, "responses": { "201": { "description": "Receipt header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreateReceiptHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreateReceiptHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/receipt-header/{receipt-header-id}": { "get": { "tags": [ "Partner Receipt" ], "description": "Get the partner receipt header", "operationId": "getPartnerReceiptHeader", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Get receipt header successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Receipt" ], "description": "Update partner receipt header", "operationId": "updatePartnerReceiptHeader", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdatePartnerReceiptHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdatePartnerReceiptHeaderRequest" } } } }, "responses": { "200": { "description": "Receipt header updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdateReceiptHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdateReceiptHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Receipt" ], "description": "Cancel the partner receipt header", "operationId": "cancelPartnerReceiptHeader", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelPartnerReceiptHeaderRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelPartnerReceiptHeaderRequest" } } } }, "responses": { "201": { "description": "Cancelled receipt header successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelReceiptHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelReceiptHeaderResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/receipt-header/{receipt-header-id}/receipt-line/{receipt-line-id}": { "get": { "tags": [ "Partner Receipt" ], "description": "Get partner receipt line detail", "operationId": "getPartnerReceiptLineDetail", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "receipt-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt line's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Receipt line retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptLineDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptLineDetailResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Receipt" ], "description": "Cancel partner receipt line", "operationId": "cancelPartnerReceiptLine", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "receipt-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt line's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelPartnerReceiptLineRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelPartnerReceiptLineRequest" } } } }, "responses": { "200": { "description": "Receipt line cancelled successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelReceiptLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CancelReceiptLineResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/receipt-header/{receipt-header-id}/receipt-line": { "get": { "tags": [ "Partner Receipt" ], "description": "Get list of partner receipt lines", "operationId": "getPartnerReceiptLines", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Receipt lines retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_GetReceiptLinesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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 Receipt" ], "description": "Create partner receipt line", "operationId": "createPartnerReceiptLine", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreatePartnerReceiptLineRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreatePartnerReceiptLineRequest" } } } }, "responses": { "201": { "description": "Receipt line created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreateReceiptLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_CreateReceiptLineResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Receipt" ], "description": "Update partner receipt lines", "operationId": "updatePartnerReceiptLines", "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": "receipt-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The receipt header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdatePartnerReceiptLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdatePartnerReceiptLinesRequest" } } } }, "responses": { "200": { "description": "Receipt lines updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdateReceiptLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerReceiptService_UpdateReceiptLinesResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] } }, "/shipment-header": { "get": { "tags": [ "Partner Shipment" ], "description": "Get list of shipment headers", "operationId": "getInventoryShipmentHeaderList", "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": "order-status", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_COMPLETION" }, { "name": "shipment-status", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_COMPLETION" }, { "name": "shipment-status-classification", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "INCOMPLETE" }, { "name": "partner-operating-name", "in": "query", "description": "A partner's operating names for results to be filtered by", "schema": { "type": "string" }, "example": "ACME Jewels" }, { "name": "order-header-id", "in": "query", "description": "Order header id(s) to filter the list of shipment headers", "schema": { "type": "array", "items": { "type": "string" } }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "sort-option", "in": "query", "description": "The attribute to sort shipment headers by", "schema": { "type": "string", "description": "The attribute to sort shipment headers by. Acceptable values include: EXPECTED_DELIVERY_DATE_ASC, EXPECTED_DELIVERY_DATE_DESC, ORDER_DATE_ASC, ORDER_DATE_DESC", "example": "EXPECTED_DELIVERY_DATE_ASC", "enum": [ "EXPECTED_DELIVERY_DATE_ASC", "EXPECTED_DELIVERY_DATE_DESC", "ORDER_DATE_ASC", "ORDER_DATE_DESC" ], "default": "" }, "example": "EXPECTED_DELIVERY_DATE_ASC" }, { "name": "order-date-range", "in": "query", "schema": { "type": "string", "enum": [ "TODAY", "YESTERDAY", "PAST_7_DAYS", "PAST_30_DAYS", "PAST_60_DAYS", "PAST_3_MONTHS", "PAST_6_MONTHS", "PAST_YEAR" ] } }, { "name": "order-created-on-start-date", "in": "query", "description": "The earliest order date to consider for search.", "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": "order-created-on-end-date", "in": "query", "description": "The latest date to consider for search.", "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": "shipment-status", "in": "query", "description": "One or more shipment statuses to filter by. Acceptable values include: PENDING_RELEASE, HELD, RELEASED, READY_TO_PICK, READY_TO_PACK, READY_TO_SHIP, CANCELLED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED", "schema": { "type": "array", "description": "One or more shipment statuses to filter by. Acceptable values include: PENDING_RELEASE, HELD, RELEASED, READY_TO_PICK, READY_TO_PACK, READY_TO_SHIP, CANCELLED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED", "items": { "type": "string", "example": "PENDING_ACTIVATION", "enum": [ "PENDING_RELEASE", "HELD", "RELEASED", "READY_TO_PICK", "READY_TO_PACK", "READY_TO_SHIP", "CANCELLED", "SHIPPED", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED" ] } }, "example": "PENDING_RELEASE" }, { "name": "order-type", "in": "query", "description": "A collection of the desired order type codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PARTNER_REMOVAL_ORDER" } ], "responses": { "200": { "description": "Shipment headers returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentHeadersResponse" } } } }, "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": "Shipment headers for requested criteria do 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}/shipment-header/{shipment-header-id}/shipment-line/{shipment-line-id}": { "get": { "tags": [ "Partner Shipment" ], "description": "Get inventory shipment line", "operationId": "getInventoryShipmentLine", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Shipment line returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentLineResponse" } } } }, "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": "Shipment line for requested criteria 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" } } } ] }, "delete": { "tags": [ "Partner Shipment" ], "description": "Cancel inventory shipment line", "operationId": "deleteInventoryShipmentLine", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Shipment line has cancelled successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentLineResponse" } } } }, "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": "Shipment lines for requested criteria do 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}/shipment-header": { "get": { "tags": [ "Partner Shipment" ], "description": "Get list of shipment headers for the partner", "operationId": "getInventoryShipmentHeaders", "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": "order-status", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_COMPLETION" }, { "name": "shipment-status", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_COMPLETION" }, { "name": "shipment-status-classification", "in": "query", "description": "A collection of the desired order status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "INCOMPLETE" }, { "name": "partner-operating-name", "in": "query", "description": "A partner's operating names for results to be filtered by", "schema": { "type": "string" }, "example": "ACME Jewels" }, { "name": "order-header-id", "in": "query", "description": "Order header id(s) to filter the list of shipment headers", "schema": { "type": "array", "items": { "type": "string" } }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "sort-option", "in": "query", "description": "The attribute to sort shipment headers by", "schema": { "type": "string", "description": "The attribute to sort shipment headers by. Acceptable values include: EXPECTED_DELIVERY_DATE_ASC, EXPECTED_DELIVERY_DATE_DESC, ORDER_DATE_ASC, ORDER_DATE_DESC", "example": "EXPECTED_DELIVERY_DATE_ASC", "enum": [ "EXPECTED_DELIVERY_DATE_ASC", "EXPECTED_DELIVERY_DATE_DESC", "ORDER_DATE_ASC", "ORDER_DATE_DESC" ], "default": "" }, "example": "EXPECTED_DELIVERY_DATE_ASC" }, { "name": "order-date-range", "in": "query", "schema": { "type": "string", "enum": [ "TODAY", "YESTERDAY", "PAST_7_DAYS", "PAST_30_DAYS", "PAST_60_DAYS", "PAST_3_MONTHS", "PAST_6_MONTHS", "PAST_YEAR" ] } }, { "name": "order-created-on-start-date", "in": "query", "description": "The earliest order date to consider for search.", "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": "order-created-on-end-date", "in": "query", "description": "The latest date to consider for search.", "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": "shipment-status", "in": "query", "description": "One or more shipment statuses to filter by. Acceptable values include: PENDING_RELEASE, HELD, RELEASED, READY_TO_PICK, READY_TO_PACK, READY_TO_SHIP, CANCELLED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED", "schema": { "type": "array", "description": "One or more shipment statuses to filter by. Acceptable values include: PENDING_RELEASE, HELD, RELEASED, READY_TO_PICK, READY_TO_PACK, READY_TO_SHIP, CANCELLED, SHIPPED, IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED", "items": { "type": "string", "example": "PENDING_ACTIVATION", "enum": [ "PENDING_RELEASE", "HELD", "RELEASED", "READY_TO_PICK", "READY_TO_PACK", "READY_TO_SHIP", "CANCELLED", "SHIPPED", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED" ] } }, "example": "PENDING_RELEASE" }, { "name": "order-type", "in": "query", "description": "A collection of the desired order type codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PARTNER_REMOVAL_ORDER" }, { "name": "partner-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner shipment headers returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentHeadersResponse" } } } }, "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": "Shipment headers for requested criteria do 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}/shipment-header/{shipment-header-id}/shipment-line": { "get": { "tags": [ "Partner Shipment" ], "description": "Get list of inventory shipment lines", "operationId": "getInventoryShipmentLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "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": 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": "shipment-line-status", "in": "query", "description": "A collection of the desired shipment line status codes", "schema": { "type": "array", "items": { "type": "string" } }, "example": "PENDING_COMPLETION" } ], "responses": { "200": { "description": "Shipment lines returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentLinesResponse" } } } }, "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": "Shipment lines for requested criteria do 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" } } } ] }, "patch": { "tags": [ "Partner Shipment" ], "description": "Update inventory shipment line quantity", "operationId": "updateInventoryShipmentLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentLinesRequest" } } } }, "responses": { "200": { "description": "Shipment line has been updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentLinesResponse" } } } }, "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": "Shipment lines for requested criteria do 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}/shipment-header/{shipment-header-id}": { "get": { "tags": [ "Partner Shipment" ], "description": "Get shipment header detail", "operationId": "getInventoryShipmentHeaderDetail", "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": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Shipment header detail returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentHeaderDetailResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentHeaderDetailResponse" } } } }, "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": "Shipment header detail for requested criteria 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}/shipment-header/{shipment-header-id}/package-header": { "get": { "tags": [ "Partner Shipment" ], "description": "Get list of package headers", "operationId": "getInventoryShipmentPackageHeaders", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "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": 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": "sort-ascending", "in": "query", "description": "Package ordinal sorting option; true=ascending, false=descending", "schema": { "type": "string", "default": "true" }, "example": true } ], "responses": { "200": { "description": "Package headers have successfully retrieved", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageHeadersResponse" } } } }, "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 headers for requested shipment do 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" } } } ] }, "post": { "tags": [ "Partner Shipment" ], "description": "Create inventory shipment package header", "operationId": "createInventoryShipmentPackageHeader", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Package header has cancelled successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageHeaderResponse" } } } }, "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": "Shipment lines for requested criteria do 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" } } } ] }, "delete": { "tags": [ "Partner Shipment" ], "description": "Delete inventory shipment package headers", "operationId": "deleteInventoryShipmentPackageHeaders", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageHeadersRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageHeadersRequest" } } } }, "responses": { "200": { "description": "Package headers have cancelled successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageHeadersResponse" } } } }, "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": "Shipment lines for requested criteria do 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" } } } ] }, "patch": { "tags": [ "Partner Shipment" ], "description": "Update inventory shipment package headers", "operationId": "updateInventoryShipmentPackageHeaders", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageHeadersRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageHeadersRequest" } } } }, "responses": { "200": { "description": "Package header(s) updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageHeaderResponse" } } } }, "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 processed because of a conflict in the resource.", "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}/shipment-header/{shipment-header-id}/package-header/{package-header-id}/package-line": { "get": { "tags": [ "Partner Shipment" ], "description": "Get list of package lines", "operationId": "getInventoryShipmentPackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "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": 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": "sort-option", "in": "query", "description": "The sort order of results, either LINE_NUMBER_ASC or LINE_NUMBER_DESC", "schema": { "type": "string", "default": "LINE_NUMBER_ASC" }, "example": "LINE_NUMBER_ASC" } ], "responses": { "200": { "description": "Package lines have been successfully retrieved", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageLinesResponse" } } } }, "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 line details do not exist for provided parameters", "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 Shipment" ], "description": "Create inventory shipment package lines", "operationId": "createInventoryShipmentPackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageLineRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageLineRequest" } } } }, "responses": { "201": { "description": "Request to create package lines has been processed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageLinesResponse" } } } }, "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 header detail for requested package do 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" } } } ] }, "delete": { "tags": [ "Partner Shipment" ], "description": "Delete inventory shipment package lines", "operationId": "deleteInventoryShipmentPackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageLineRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageLineRequest" } } } }, "responses": { "200": { "description": "Request to delete package lines has been processed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLinesResponse" } } } }, "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 header detail for requested package do 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" } } } ] }, "patch": { "tags": [ "Partner Shipment" ], "description": "Update inventory shipment package lines", "operationId": "updateInventoryShipmentPackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLineRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLineRequest" } } } }, "responses": { "200": { "description": "Request to update package lines has been processed", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLinesResponse" } } } }, "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 header detail for requested package do 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}/shipment-header/{shipment-header-id}/package-header/{package-header-id}": { "get": { "tags": [ "Partner Shipment" ], "description": "Get package header details", "operationId": "getInventoryShipmentPackageHeaderDetail", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Package header has successfully retrieved", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageHeadersResponse" } } } }, "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 header detail for requested package do 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}/shipment-header/{shipment-header-id}/package-header/{package-header-id}/package-line/{package-line-id}": { "get": { "tags": [ "Partner Shipment" ], "description": "Get a package line", "operationId": "getInventoryShipmentPackageLine", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "package-line-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package line's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "responses": { "200": { "description": "Package line has been successfully retrieved", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageLineResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryShipmentPackageLineResponse" } } } }, "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 line details do not exist for provided parameters", "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}/inventory-removal-package-labels": { "post": { "tags": [ "Partner Shipment" ], "description": "Get partner inventory removal package labels PDF documents", "operationId": "createInventoryRemovalPackageLabels", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryRemovalPackageLabelsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetInventoryRemovalPackageLabelsRequest" } } }, "required": true }, "responses": { "201": { "description": "Package label PDF documents retrieved successfully" }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Access to this service is not allowed.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The resource requested could not be found.", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Error when processing the request. Invalid request", "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" } } } ] } }, "/partner/{partner-id}/inventory-removal-pack-list": { "post": { "tags": [ "Partner Shipment" ], "description": "Get inventory removal packing list in PDF format.", "operationId": "createInventoryRemovalPackingListPDF", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerInventoryRemovalPackingListRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerInventoryRemovalPackingListRequest" } } } }, "responses": { "200": { "description": "Inventory removal packing list retrieved successfully for the partner", "content": { "application/pdf": { "schema": { "type": "file", "format": "binary" } } } }, "401": { "description": "Unauthorized", "content": { "application/json; 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" } } } }, "404": { "description": "No packing list exists for the partner package id", "content": { "application/json; 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" } } } } }, "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}/shipment-header/{shipment-header-id}/package-header/{package-header-id}/package-line": { "get": { "tags": [ "Partner Shipment" ], "description": "Get package lines in a package", "operationId": "getPackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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": "keyword-search", "in": "query", "description": "A string to search the package lines by. Can include sku, style, supplier numbers or title keywords to perform a title search.", "schema": { "type": "string", "description": "A string to search the package lines by. Can include sku, style, supplier numbers or title keywords to perform a title search." } }, { "name": "sort-attribute", "in": "query", "schema": { "type": "string", "description": "Describes the sort types, ascending or descending", "xml": { "name": "sortAttributeCode" }, "enum": [ "LINE_NUMBER_ASC", "LINE_NUMBER_DESC" ] } } ], "responses": { "200": { "description": "Package lines are returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetPackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetPackageLinesResponse" } } } }, "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 ID, Order Header ID, Shipment Header ID, or Package Header 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" } } } ] }, "post": { "tags": [ "Partner Shipment" ], "description": "Create package lines in a package", "operationId": "createPackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesRequest" } } } }, "responses": { "201": { "description": "Package lines are created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesResponse" } } } }, "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 ID, Order Header ID, Shipment Header ID, or Package Header 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" } } } ] }, "delete": { "tags": [ "Partner Shipment" ], "description": "Delete package lines from a package", "operationId": "deletePackageLines", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageLinesRequest" } } } }, "responses": { "200": { "description": "Package lines are deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageLinesResponse" } } } }, "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 ID, Order Header ID, Shipment Header ID, or Package Header 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" } } } ] }, "patch": { "tags": [ "Partner Shipment" ], "description": "Update package lines in a package", "operationId": "updatePackageLines_1", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdatePackageLinesRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdatePackageLinesRequest" } } } }, "responses": { "200": { "description": "Package lines are updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesResponse" } } } }, "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 ID, Order Header ID, Shipment Header ID, or Package Header 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/{partner-id}/order-header/{order-header-id}/shipment-header": { "get": { "tags": [ "Partner Shipment" ], "description": "Get shipment headers for an order", "operationId": "getShipmentHeaders", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Shipment headers returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetShipmentHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetShipmentHeadersResponse" } } } }, "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 ID or Order Header 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/{partner-id}/order-header/{order-header-id}/shipment-header/{shipment-header-id}/status-history": { "get": { "tags": [ "Partner Shipment" ], "description": "Get shipment status history", "operationId": "getShipmentStatusHistory", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Shipment status audit returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetShipmentStatusHistoryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetShipmentStatusHistoryResponse" } } } }, "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 ID, Order Header ID or Shipment Header 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/{partner-id}/order-header/{order-header-id}/shipment-header/{shipment-header-id}/rate-options": { "get": { "tags": [ "Partner Shipment" ], "description": "Get the carrier shipment rate options", "operationId": "getShipmentRateOptions", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "ship-date", "in": "query", "schema": { "$ref": "#/components/schemas/ship-date" } } ], "responses": { "200": { "description": "Shipment rate options are returned", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetShipmentRateOptionsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetShipmentRateOptionsResponse" } } } }, "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 ID, Order Header ID, or Shipment Header 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/{partner-id}/order-header/{order-header-id}/shipment-header/{shipment-header-id}/package-header": { "get": { "tags": [ "Partner Shipment" ], "description": "Get package headers for a shipment", "operationId": "getPackageHeaders", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "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 } ], "responses": { "201": { "description": "Package headers returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetPackageHeadersResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetPackageHeadersResponse" } } } }, "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 ID, Order Header ID or Shipment Header 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" } } } ] }, "post": { "tags": [ "Partner Shipment" ], "description": "Create Package Header", "operationId": "createPackageHeader_1", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Package header created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_CreatePackageLinesResponse" } } } }, "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 ID, Order Header ID, or Shipment Header 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" } } } ] }, "delete": { "tags": [ "Partner Shipment" ], "description": "Delete Package Headers", "operationId": "deletePackageHeaders_1", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageHeadersRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageHeadersRequest" } } } }, "responses": { "200": { "description": "Package lines are deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageLinesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_DeletePackageLinesResponse" } } } }, "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 ID, Order Header ID, Shipment Header ID, or Package Header 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" } } } ] }, "patch": { "tags": [ "Partner Shipment" ], "description": "Update Package Headers", "operationId": "updatePackageHeaders_1", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdatePackageHeadersRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerOrderService_UpdatePackageHeadersRequest" } } } }, "responses": { "200": { "description": "Package Header", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdatePackageHeaderResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_UpdatePackageHeaderResponse" } } } }, "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 processed because of a conflict in the resource.", "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}/shipment-header/{shipment-header-id}/package-header/{package-header-id}/tracking-events": { "get": { "tags": [ "Partner Shipment" ], "description": "Get tracking events for a package", "operationId": "getTrackingEvents_1", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The order header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The shipment header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "package-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The package header's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Tracking events are returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetTrackingEventsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentService_GetTrackingEventsResponse" } } } }, "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 ID, Order Header ID, Shipment Header ID, or Package Header 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/{partner-id}/order-header/{order-header-id}/shipment-header/{shipment-header-id}/shipment-label": { "get": { "tags": [ "Partner Shipment Label" ], "description": "Get shipment labels for enterprise partner", "operationId": "getPartnerShipmentLabels", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shipment unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner order unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shipment Label retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentLabelService_PartnerShipmentLabelsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentLabelService_PartnerShipmentLabelsResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Shipment Label" ], "description": "Void shipment labels for enterprise partner order", "operationId": "voidPartnerShipmentLabel", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "shipment-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shipment unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "order-header-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner order unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner shipment label voided successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentLabelService_VoidShipmentResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShipmentLabelService_VoidShipmentResponse" } } } }, "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}/shop-profile/{profile-id}": { "get": { "tags": [ "Partner Shop Profile" ], "description": "View my partner shop profile.", "operationId": "getPartnerShopProfile", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shop Profile retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileResponse" } } } }, "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 Shop Profile" ], "description": "Update my partner shop profile.", "operationId": "updatePartnerShopProfile", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileRequest" } } } }, "responses": { "200": { "description": "Partner Shop Profile Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileResponse" } } } }, "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}/shop-profile": { "get": { "tags": [ "Partner Shop Profile" ], "description": "View my partner shop profile.", "operationId": "getPartnerShopProfiles", "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": { "200": { "description": "Partner Shop Profiles retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfilesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfilesResponse" } } } }, "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 Shop Profile" ], "description": "Create my partner shop profile.", "operationId": "createPartnerShopProfile", "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/PartnerShopProfileService_CreatePartnerShopProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileResponse" } } } }, "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}/shop-profile/{profile-id}/about-item": { "get": { "tags": [ "Partner Shop Profile" ], "description": "View about items for a partner's shop profile.", "operationId": "getPartnerShopProfileAboutItems", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shop Profile About Items retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileAboutItemsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileAboutItemsResponse" } } } }, "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 Shop Profile" ], "description": "Create about items for a partner's shop profile.", "operationId": "createPartnerShopProfileAboutItems", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileAboutItemsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileAboutItemsRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile About Items created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileAboutItemsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileAboutItemsResponse" } } } }, "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}/shop-profile/{profile-id}/external-link": { "get": { "tags": [ "Partner Shop Profile" ], "description": "View external links for a partner's shop profile.", "operationId": "getPartnerShopProfileExternalLinks", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shop Profile External Links retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileExternalLinksResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileExternalLinksResponse" } } } }, "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 Shop Profile" ], "description": "Create external links for a partner's shop profile.", "operationId": "createPartnerShopProfileExternalLinks", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileExternalLinksRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileExternalLinksRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile External Links created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileExternalLinksResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileExternalLinksResponse" } } } }, "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}/shop-profile/{profile-id}/featured-listing": { "get": { "tags": [ "Partner Shop Profile" ], "description": "View featured listings for a partner's shop profile.", "operationId": "getPartnerShopProfileFeaturedListings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shop Profile Featured Listing created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileFeaturedListingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileFeaturedListingsResponse" } } } }, "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 Shop Profile" ], "description": "Create featured listings for a partner's shop profile.", "operationId": "createPartnerShopProfileFeaturedListings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFeaturedListingsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFeaturedListingsRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile Featured Listing created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileFeaturedListingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileFeaturedListingsResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Shop Profile" ], "description": "Delete partner shop profile's featured listing", "operationId": "deletePartnerShopProfileFeaturedListings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "featured-listings-uuids", "in": "query", "description": "Featured Listings Uuids to delete", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" } ], "responses": { "200": { "description": "Partner shop profile's featured listing deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeleteShopProfileFeaturedListingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeleteShopProfileFeaturedListingsResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Shop Profile" ], "description": "Update featured listings for a partner's shop profile.", "operationId": "updatePartnerShopProfileFeaturedListings", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListingsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListingsRequest" } } } }, "responses": { "200": { "description": "Partner Shop Profile Featured Listing updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileFeaturedListingsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileFeaturedListingsResponse" } } } }, "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}/shop-profile/{profile-id}/policy": { "get": { "tags": [ "Partner Shop Profile" ], "description": "Create partner's shop profile policy.", "operationId": "getPartnerShopProfilePolicy", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner Shop Profile Policy created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetShopProfilePolicyResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetShopProfilePolicyResponse" } } } }, "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 Shop Profile" ], "description": "Create partner's shop profile policy.", "operationId": "createPartnerShopProfilePolicy", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateShopProfilePolicyRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateShopProfilePolicyRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile Policy created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreateShopProfilePolicyResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreateShopProfilePolicyResponse" } } } }, "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}/shop-profile/{profile-id}/faq-item": { "get": { "tags": [ "Partner Shop Profile" ], "description": "View FAQ items for a partner's shop profile.", "operationId": "getPartnerShopProfileFaqItems", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shop Profile FAQ Items retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileFaqItemsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileFaqItemsResponse" } } } }, "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 Shop Profile" ], "description": "Create FAQ items for a partner's shop profile.", "operationId": "createPartnerShopProfileFaqItems", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFaqItemsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFaqItemsRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile FAQ Items created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileFaqItemsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileFaqItemsResponse" } } } }, "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}/shop-profile/shop-name-availability-status": { "get": { "tags": [ "Partner Shop Profile" ], "description": "Determine the availability of a shop profile name", "operationId": "getPartnerShopProfileNameAvailability", "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": "shop-profile-name", "in": "query", "description": "The URI-encoded shop profile name to check. Max = 100 chars. Valid chars: a-z A-Z 0-9 : & , ' ( ) - + ! space", "required": true, "schema": { "type": "string", "description": "The URI-encoded shop profile name to check", "example": "My%20Super%20Shop" }, "example": "My%20Super%20Shop" } ], "responses": { "200": { "description": "Partner Shop Profile Name availability check was successful", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileNameAvailabilityResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileNameAvailabilityResponse" } } } }, "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}/shop-profile/{profile-id}/status": { "post": { "tags": [ "Partner Shop Profile" ], "description": "Update partner's shop profile status.", "operationId": "updatePartnerShopProfileStatus", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdateShopProfileStatusRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdateShopProfileStatusRequest" } } } }, "responses": { "200": { "description": "Partner Shop Profile Status updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdateShopProfileStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdateShopProfileStatusResponse" } } } }, "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}/shop-profile/{profile-id}/media-upload-uri": { "post": { "tags": [ "Partner Shop Profile" ], "description": "Create a media upload URI for shop profile content.", "operationId": "createPartnerShopProfileMediaUploadUri", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileMediaUploadUriRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileMediaUploadUriRequest" } } } }, "responses": { "201": { "description": "Partner Shop Media Upload URI created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileMediaUploadUriResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileMediaUploadUriResponse" } } } }, "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}/shop-profile/{profile-id}/completion-status": { "get": { "tags": [ "Partner Shop Profile" ], "description": "get partner's shop profile completion status.", "operationId": "getPartnerShopProfileCompletionStatus", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner Shop Profile Completion Status", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetShopProfileCompletionStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetShopProfileCompletionStatusResponse" } } } }, "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}/shop-profile/{profile-id}/featured-media": { "get": { "tags": [ "Partner Shop Profile" ], "description": "Get featured media for a partner's shop profile.", "operationId": "getPartnerShopProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner Shop Profile Featured Media returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileMediaResponse" } } } }, "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 Shop Profile" ], "description": "Create featured media for a partner's shop profile.", "operationId": "createPartnerShopProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFeaturedMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFeaturedMediaRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile Featured Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileFeaturedMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileFeaturedMediaResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Shop Profile" ], "description": "Update featured media for a partner's shop profile.", "operationId": "updatePartnerShopProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileMediaRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile Featured Media updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileMediaResponse" } } } }, "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}/shop-profile/{profile-id}/featured-media/{media-id}": { "delete": { "tags": [ "Partner Shop Profile" ], "description": "Delete featured media from a partner's shop profile.", "operationId": "deletePartnerShopProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "media-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The media's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner Shop Profile Featured Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerShopProfileMediaResponse" } } } }, "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}/shop-profile/{profile-id}/about-media": { "get": { "tags": [ "Partner Shop Profile" ], "description": "Get about media for a partner's shop profile.", "operationId": "getPartnerShopProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner Shop Profile About Media returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerShopProfileMediaResponse" } } } }, "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 Shop Profile" ], "description": "Create about media for a partner's shop profile.", "operationId": "createPartnerShopProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileAboutMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileAboutMediaRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile About Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileAboutMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileAboutMediaResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Shop Profile" ], "description": "Update about media for a partner's shop profile.", "operationId": "updatePartnerShopProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileMediaRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile About Media updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerShopProfileMediaResponse" } } } }, "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}/shop-profile/{profile-id}/about-media/{media-id}": { "delete": { "tags": [ "Partner Shop Profile" ], "description": "Delete about media from a partner's shop profile.", "operationId": "deletePartnerShopProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "media-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The media's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner Shop Profile About Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerShopProfileMediaResponse" } } } }, "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}/shop-profile/{profile-id}/profile-media": { "post": { "tags": [ "Partner Shop Profile" ], "description": "Create profile media for a partner's shop profile.", "operationId": "createPartnerShopProfileMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileMediaRequest" } } } }, "responses": { "201": { "description": "Partner Shop Profile Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerShopProfileMediaResponse" } } } }, "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}/shop-profile/{profile-id}/profile-media/{media-id}": { "delete": { "tags": [ "Partner Shop Profile" ], "description": "Delete profile media from a partner's shop profile.", "operationId": "deletePartnerShopProfileMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "media-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The media's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner Shop Profile Profile Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerShopProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerShopProfileMediaResponse" } } } }, "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}/subscriber-subscription": { "get": { "tags": [ "Partner Subscriber Subscription" ], "description": "Get partner subscriber subscription list for a partner.", "operationId": "getPartnerSubscriberSubscriptions", "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" } } ], "responses": { "200": { "description": "Partner Subscriber Subscriptions", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionsResponse" } } } }, "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 Subscriber Subscription" ], "description": "Create partner subscriber subscription", "operationId": "createSubscriberSubscription", "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/PartnerSubscriberSubscriptionService_CreateSubscriberSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_CreateSubscriberSubscriptionRequest" } } } }, "responses": { "201": { "description": "Created partner subscriber subscription", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_CreateSubscriberSubscriptionInteractionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_CreateSubscriberSubscriptionInteractionResponse" } } } }, "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}/subscriber-subscription/{subscriber-subscription-id}": { "get": { "tags": [ "Partner Subscriber Subscription" ], "description": "Get partner subscriber subscription for a partner by subscriber subscription id", "operationId": "getPartnerSubscriberSubscriptionByUuid_1", "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": "subscriber-subscription-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique subscriber subscription id" } } ], "responses": { "200": { "description": "Partner subscriber subscription returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionResponse" } } } }, "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" } } } ] }, "post": { "tags": [ "Partner Subscriber Subscription" ], "description": "Update partner subscriber subscription", "operationId": "updateSubscriberSubscription", "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": "subscriber-subscription-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique subscriber subscription id" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_UpdateSubscriberSubscriptionRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_UpdateSubscriberSubscriptionRequest" } } } }, "responses": { "201": { "description": "Updated partner subscriber subscription", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_UpdatePartnerSubscriberSubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_UpdatePartnerSubscriberSubscriptionResponse" } } } }, "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" } } } ] }, "delete": { "tags": [ "Partner Subscriber Subscription" ], "description": "Deactivate partner subscriber subscription", "operationId": "deletePartnerSubscriberSubscription", "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": "subscriber-subscription-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique subscriber subscription id" } } ], "responses": { "200": { "description": "Partner subscriber subscription deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_DeletePartnerSubscriberSubscriptionResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_DeletePartnerSubscriberSubscriptionResponse" } } } }, "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}/pricing-proposal": { "post": { "tags": [ "Partner Supplier Pricing" ], "description": "Create a batch of partner supplier pricing proposals", "operationId": "createSupplierPricingProposals", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_CreateSupplierPricingProposalsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_CreateSupplierPricingProposalsRequest" } } } }, "responses": { "201": { "description": "Proposals created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_CreateSupplierPricingProposalsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_CreateSupplierPricingProposalsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "Partner Supplier Pricing" ], "description": "Update a batch of partner supplier pricing proposals", "operationId": "updateSupplierPricingProposals", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_UpdateSupplierPricingProposalsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_UpdateSupplierPricingProposalsRequest" } } } }, "responses": { "200": { "description": "Proposals updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_UpdateSupplierPricingProposalsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_UpdateSupplierPricingProposalsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/pricing-proposal/{sku-number}": { "get": { "tags": [ "Partner Supplier Pricing" ], "description": "Get the pricing history of a SKU", "operationId": "getSupplierPricingProposals", "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", "description": "The partner's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, { "name": "sku-number", "in": "path", "description": "The product number of the SKU", "required": true, "schema": { "type": "string", "description": "The product number of the SKU", "example": "ACW2570" }, "example": "ACW2570" }, { "name": "service", "in": "query", "description": "The code of the enrolled service offering to filter on", "required": true, "schema": { "type": "string", "description": "The code of the enrolled service offering to filter on", "example": "JTV_CONSIGNMENT" }, "example": "CONSIGNMENT" }, { "name": "status-filter", "in": "query", "description": "Status filter to apply, if any", "schema": { "type": "string", "description": "The status to filter proposals by. All proposals will be returned if the filter is not provided", "enum": [ "PENDING_REVIEW", "ACCEPTED", "REJECTED", "EXPIRED", "CANCELLED", "PENDING_REVIEW", "ACCEPTED", "REJECTED", "EXPIRED", "CANCELLED" ] }, "example": "PENDING_REVIEW" } ], "responses": { "200": { "description": "Proposal history fetched successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_UpdateSupplierPricingProposalsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerSupplierPricingService_UpdateSupplierPricingProposalsResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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}/user-profile": { "get": { "tags": [ "User Public Profile" ], "description": "View a partner's and/or associate's user public profiles.", "operationId": "getPartnerUserProfiles", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "associate-id", "in": "query", "description": "The optional associate unique universal identifier, if only the profile available to a specific associate are desired.", "required": true, "schema": { "type": "string" }, "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, { "name": "profile-type-code", "in": "query", "schema": { "type": "array", "description": "The profile type code. If provided the API will only return profiles that have given profile type code.", "example": "SELLER", "items": { "type": "string", "description": "The profile type code. If provided the API will only return profiles that have given profile type code.", "example": "SELLER" } } } ], "responses": { "200": { "description": "Partner User Profiles retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfilesResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfilesResponse" } } } }, "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": [ "User Public Profile" ], "description": "Create my user public profile.", "operationId": "createPartnerUserProfile", "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/PartnerShopProfileService_CreateUserProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateUserProfileRequest" } } } }, "responses": { "201": { "description": "User Public Profile Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreateUserProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreateUserProfileResponse" } } } }, "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}/user-profile/{profile-id}": { "get": { "tags": [ "User Public Profile" ], "description": "View my user public profile.", "operationId": "getPartnerUserProfile", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner User Profile retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileResponse" } } } }, "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": [ "User Public Profile" ], "description": "Update my partner user profile.", "operationId": "updatePartnerUserProfile", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileRequest" } } } }, "responses": { "200": { "description": "Partner User Profile Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileResponse" } } } }, "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}/user-profile/{profile-id}/completion-status": { "get": { "tags": [ "User Public Profile" ], "description": "Get a partner user profile's milestone completion status.", "operationId": "getPartnerUserProfileCompletionStatus", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner User Profile Completion Status retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileCompletionStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileCompletionStatusResponse" } } } }, "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}/user-profile/{profile-id}/status": { "post": { "tags": [ "User Public Profile" ], "description": "Update a partner user profile's activation status.", "operationId": "updatePartnerUserProfileStatus", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdateUserProfileStatusRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdateUserProfileStatusRequest" } } } }, "responses": { "200": { "description": "Partner User Profile Completion Status retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdateUserProfileStatusResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdateUserProfileStatusResponse" } } } }, "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}/user-profile/{profile-id}/about-media": { "get": { "tags": [ "User Public Profile" ], "description": "Get about media for a partner's user profile.", "operationId": "getPartnerUserProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner User Profile About Media returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileMediaResponse" } } } }, "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": [ "User Public Profile" ], "description": "Create about media for a partner's user profile.", "operationId": "createPartnerUserProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutMediaRequest" } } } }, "responses": { "201": { "description": "Partner User Profile About Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutMediaResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "User Public Profile" ], "description": "Update about media for a partner's user profile.", "operationId": "updatePartnerUserProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaRequest" } } } }, "responses": { "201": { "description": "Partner User Profile About Media updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaResponse" } } } }, "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}/user-profile/{profile-id}/about-media/{media-id}": { "delete": { "tags": [ "User Public Profile" ], "description": "Delete about media from a partner's user profile.", "operationId": "deletePartnerUserProfileAboutMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "media-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The media's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner User Profile About Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerUserProfileMediaResponse" } } } }, "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}/user-profile/{profile-id}/featured-media": { "get": { "tags": [ "User Public Profile" ], "description": "Get featured media for a partner's user profile.", "operationId": "getPartnerUserProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner User Profile Featured Media returned successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileMediaResponse" } } } }, "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": [ "User Public Profile" ], "description": "Create featured media for a partner's user profile.", "operationId": "createPartnerUserProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileFeaturedMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileFeaturedMediaRequest" } } } }, "responses": { "201": { "description": "Partner User Profile Featured Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileFeaturedMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileFeaturedMediaResponse" } } } }, "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" } } } ] }, "patch": { "tags": [ "User Public Profile" ], "description": "Update featured media for a partner's user profile.", "operationId": "updatePartnerUserProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaRequest" } } } }, "responses": { "201": { "description": "Partner User Profile Featured Media updated successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdatePartnerUserProfileMediaResponse" } } } }, "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}/user-profile/{profile-id}/featured-media/{media-id}": { "delete": { "tags": [ "User Public Profile" ], "description": "Delete featured media from a partner's user profile.", "operationId": "deletePartnerUserProfileFeaturedMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "media-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The media's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner User Profile Featured Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerUserProfileMediaResponse" } } } }, "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}/user-profile/{profile-id}/about-item": { "get": { "tags": [ "User Public Profile" ], "description": "View about items for a partner's user profile.", "operationId": "getPartnerUserProfileAboutItems", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner User Profile About Items retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileAboutItemsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_GetPartnerUserProfileAboutItemsResponse" } } } }, "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": [ "User Public Profile" ], "description": "Create about items for a partner's user profile.", "operationId": "createPartnerUserProfileAboutItems", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutItemsRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutItemsRequest" } } } }, "responses": { "201": { "description": "Partner User Profile About Items created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutItemsResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileAboutItemsResponse" } } } }, "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}/user-profile/{profile-id}/external-link": { "get": { "tags": [ "User Public Profile" ], "description": "View external links for a partner's user profile.", "operationId": "getPartnerUserProfileExternalLink", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "200": { "description": "Partner User Profile External Links retrieved successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerUserProfileExternalLinkResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_GetPartnerUserProfileExternalLinkResponse" } } } }, "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": [ "User Public Profile" ], "description": "Create external links for a partner's user profile.", "operationId": "createPartnerUserProfileExternalLink", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerUserProfileExternalLinkRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerUserProfileExternalLinkRequest" } } } }, "responses": { "201": { "description": "Partner User Profile External Links created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerUserProfileExternalLinkResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerUserProfileExternalLinkResponse" } } } }, "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}/user-profile/{profile-id}/media-upload-uri": { "post": { "tags": [ "User Public Profile" ], "description": "Create a media upload URI for user profile content.", "operationId": "createPartnerUserProfileMediaUploadUri", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaUploadUriRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaUploadUriRequest" } } } }, "responses": { "201": { "description": "Partner User Media Upload URI created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaUploadUriResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaUploadUriResponse" } } } }, "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}/user-profile/{profile-id}/profile-media": { "post": { "tags": [ "User Public Profile" ], "description": "Create profile media for a partner's user profile.", "operationId": "createPartnerUserProfileMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner shop profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaRequest" } } } }, "responses": { "201": { "description": "Partner User Profile Media created successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerUserProfileService_CreatePartnerUserProfileMediaResponse" } } } }, "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}/user-profile/{profile-id}/profile-media/{media-id}": { "delete": { "tags": [ "User Public Profile" ], "description": "Delete profile media from a partner's user profile.", "operationId": "deletePartnerUserProfileMedia", "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 identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, { "name": "profile-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The partner user profile's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, { "name": "media-id", "in": "path", "required": true, "schema": { "type": "string", "description": "The media's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } } ], "responses": { "201": { "description": "Partner User Profile Profile Media deleted successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerUserProfileMediaResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/PartnerProfileService_DeletePartnerUserProfileMediaResponse" } } } }, "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" } } } ] } }, "/ping": { "get": { "tags": [ "Ping" ], "description": "[DONE] Ping Service to Verify Service Health Check All Way Down To The Database", "operationId": "ping", "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": "Service Available", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } } }, "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" } } } ] } }, "/ping/local": { "get": { "tags": [ "Ping" ], "description": "[DONE] Ping Service to Verify Service Health Check Just For API Gateway", "operationId": "pingLocal", "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": "Service Available", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json; charset=utf-8": { "schema": { "type": "string" } }, "application/xml; charset=utf-8": { "schema": { "type": "string" } } } } }, "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" } } } ] } }, "/product-configurator/{configurator-uuid}": { "get": { "tags": [ "Product Configurator" ], "description": "Get configurator.", "operationId": "getProductConfigurator", "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": "configurator-uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Configurator Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorService_GetConfiguratorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorService_GetConfiguratorResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Configurator does not exist", "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" } } } } }, "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" } } } ] } }, "/product-configurator/{configurator-uuid}/choice-availability": { "get": { "tags": [ "Product Configurator" ], "description": "Get configurator.", "operationId": "getConfiguratorAvailabilitySummary", "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": "configurator-uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Configurator Availablity Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorService_GetConfiguratorAvailabilitySummaryResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorService_GetConfiguratorAvailabilitySummaryResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Configurator does not exist", "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" } } } } }, "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" } } } ] } }, "/product-recipe": { "post": { "tags": [ "Product Recipe" ], "description": "Create a recipe for a custom product.", "operationId": "createProductRecipe", "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/CreateProductRecipe_CreateProductRecipeRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateProductRecipe_CreateProductRecipeRequest" } } } }, "responses": { "201": { "description": "Product Sku Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateProductRecipe_CreateProductRecipeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateProductRecipe_CreateProductRecipeResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "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" } } } }, "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" } } } } }, "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" } } } ] } }, "/product-recipe/{product-recipe-uuid}": { "get": { "tags": [ "Product Recipe" ], "description": "Get a recipe for a custom product.", "operationId": "getProductRecipeByRecipeUuid", "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": "product-recipe-uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Product Recipe Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/GetProductRecipe_GetProductRecipeResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/GetProductRecipe_GetProductRecipeResponse" } } } }, "400": { "description": "The server could not understand the request due to invalid syntax.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Product Recipe 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" } } } ] } }, "/reservation": { "post": { "tags": [ "Reservation" ], "description": "[DONE] Create a reservation for the product and get a reservation id back", "operationId": "createReservation", "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/ReservationService_CreateReservationRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_CreateReservationRequest" } } } }, "responses": { "201": { "description": "UpdateReservation Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_CreateReservationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_CreateReservationResponse" } } } }, "400": { "description": "Unable to create a reservation for the product", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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" } } } ] } }, "/reservation/{reservation-id}": { "get": { "tags": [ "Reservation" ], "description": "[DONE] Get a reservation for the product by reservation id", "operationId": "getReservation", "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": "reservation-id", "in": "path", "description": "The reservation identifier.", "required": true, "schema": { "type": "string" }, "example": 283286618 } ], "responses": { "200": { "description": "Reservation Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_GetReservationResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_GetReservationResponse" } } } }, "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": "Reservation 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": [ "Reservation" ], "description": "[DONE] Update a reservation for the product by reservation id", "operationId": "updateReservation", "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": "reservation-id", "in": "path", "description": "The reservation identifier.", "required": true, "schema": { "type": "string" }, "example": 283286618 } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_UpdateReservationRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ReservationService_UpdateReservationRequest" } } } }, "responses": { "200": { "description": "Reservation Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "400": { "description": "Unable to update a reservation for the product", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "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": "Reservation 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": [ "Reservation" ], "description": "[DONE] Delete a reservation for the product by reservation id", "operationId": "deleteReservation", "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": "reservation-id", "in": "path", "description": "The reservation identifier.", "required": true, "schema": { "type": "string" }, "example": 283286618 } ], "responses": { "200": { "description": "Reservation Deleted Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/JtvApiResponse" } } } }, "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": "Reservation 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}/sales-tax-profile": { "get": { "tags": [ "Sales Tax" ], "description": "[DONE] Get a sales tax profile based on an address id.", "operationId": "getSalesTaxProfile", "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" }, { "name": "effective-date", "in": "query", "description": "Effective date for which a sales tax profile is requested.", "example": "2019-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" } } } } ], "responses": { "200": { "description": "Sales Tax Profile", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SalesTaxService_SalesTaxResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SalesTaxService_SalesTaxResponse" } } } }, "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": "Cannot calculate sales tax profile.", "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/me": { "get": { "tags": [ "User" ], "description": "Returns the authenticated user (Based on IDP UUID).", "operationId": "getUserByIdentityProviderUUID", "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": "User Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_GetUserResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_GetUserResponse" } } } }, "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": [ "User" ], "description": "Creates the authenticated user in the JTV enterprise.", "operationId": "createUser", "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": { "201": { "description": "User Created Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_CreateUserResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_CreateUserResponse" } } } }, "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" } } } ] } }, "/user/{user-id}": { "get": { "tags": [ "User" ], "description": "Get user by JTV enterprise UUID.", "operationId": "getUser", "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", "description": "The JTV user UUID identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "responses": { "200": { "description": "User Details", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_GetUserResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_GetUserResponse" } } } }, "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": [ "User" ], "description": "Update enterprise user.", "operationId": "updateUser", "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", "description": "The JTV user UUID identifier.", "required": true, "schema": { "type": "string" }, "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } ], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_UpdateUserRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_UpdateUserRequest" } } } }, "responses": { "200": { "description": "User Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_UpdateUserResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_UpdateUserResponse" } } } }, "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/partner-associate-account": { "post": { "tags": [ "User" ], "description": "Tie enterprise user to a partner associate account", "operationId": "tieUserToPartnerAssociateAccount", "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/UserService_TieUserToPartnerAssociateAccountRequest" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_TieUserToPartnerAssociateAccountRequest" } } } }, "responses": { "200": { "description": "User Updated Successfully", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_UpdateUserResponse" } }, "application/xml; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UserService_UpdateUserResponse" } } } }, "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": "Associate invitation is not in a valid state.", "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" } } } ] } }, "/application.wadl": { "get": { "operationId": "getWadl", "responses": { "default": { "description": "default response", "content": { "application/vnd.sun.wadl+xml": {}, "application/xml": {} } } } } }, "/application.wadl/{path}": { "get": { "operationId": "getExternalGrammar", "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "default response", "content": { "application/xml": {} } } } } } }, "components": { "schemas": { "UserAgreementService_AgreementActionType": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Agreement action type unique code" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Agreement action type description" } }, "description": "User agreement action type representation.", "xml": { "name": "agreementActionType" } }, "UserAgreementService_AgreementMedia": { "type": "object", "properties": { "agreementUrl": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Agreement media URL" }, "mediaType": { "$ref": "#/components/schemas/UserAgreementService_AgreementMediaType" } }, "description": "User agreement media representation.", "xml": { "name": "agreementMedia" } }, "UserAgreementService_AgreementMediaType": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Media type unique code" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Media type description" } }, "description": "User agreement media type representation.", "xml": { "name": "agreementMediaType" } }, "UserAgreementService_UserAgreement": { "required": [ "actionTypes", "agreementRevisionId", "interactionState", "version" ], "type": "object", "properties": { "agreementRevisionId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "Agreement revision UUID" }, "interactionState": { "type": "string", "description": "Agreement interaction state", "enum": [ "AVAILABLE", "ACCEPTED" ] }, "version": { "maxLength": 20, "minLength": 0, "type": "string", "description": "Agreement version" }, "lastConsentVersion": { "maxLength": 20, "minLength": 0, "type": "string", "description": "The latest version agreement is consented" }, "lastConsentDatetime": { "type": "string", "description": "Agreement last consent date", "format": "date-time", "example": "2016-03-28T12:26:21-04:00" }, "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Agreement unique code" }, "title": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Agreement title" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Agreement description" }, "mediaList": { "type": "array", "description": "Agreement media list", "items": { "$ref": "#/components/schemas/UserAgreementService_AgreementMedia" } }, "actionTypes": { "type": "array", "description": "Agreement action types", "items": { "$ref": "#/components/schemas/UserAgreementService_AgreementActionType" } } }, "description": "User agreement resource representation.", "xml": { "name": "userAgreement" } }, "UserAgreementService_UserAgreementListResponse": { "required": [ "userAgreements" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "userAgreements": { "type": "array", "description": "List of user agreements", "xml": { "name": "userAgreementList", "wrapped": true }, "items": { "$ref": "#/components/schemas/UserAgreementService_UserAgreement" } } }, "xml": { "name": "userAgreementListResponse" } }, "ErrorResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string", "description": "The error message.", "example": "Invalid Request" }, "errors": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/JtvValidationError" } } }, "xml": { "name": "errorResponse" } }, "JtvValidationError": { "type": "object", "properties": { "property": { "type": "string" }, "message": { "type": "string" }, "invalidValue": { "type": "string" } } }, "DateType": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "format": "string", "xml": { "name": "dateType" } }, "agreement-action-type": { "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" } }, "UserAgreementService_CreateAgreementInteractionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "agreementInteractionId": { "type": "string", "description": "Agreement interaction id" } }, "xml": { "name": "createAgreementInteractionResponse" } }, "CreateAgreementInteraction": { "required": [ "agreementRevisionId" ], "type": "object", "properties": { "agreementRevisionId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "Agreement Revision UUID", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "The agreement interaction" }, "UserAgreementService_UserAgreementInteractRequest": { "required": [ "createAgreementInteraction" ], "type": "object", "properties": { "createAgreementInteraction": { "$ref": "#/components/schemas/CreateAgreementInteraction" } }, "xml": { "name": "userAgreementInteractRequest" } }, "ContactService_PromotionalSubscriptionResponse": { "required": [ "createDate" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "requestRelationshipId": { "type": "string", "description": "The unique Relationship Id of SMS and email.", "example": "SUB9981234" }, "requestId": { "type": "integer", "description": "The unique request id for promotions", "format": "int32" }, "createDate": { "type": "string", "description": "The date the subscription queue record was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "promotionalSubscriptionResponse" } }, "ContactService_PromotionalSubscriptionRequest": { "required": [ "requestDate", "site" ], "type": "object", "properties": { "emailAddress": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The subscription target email address.", "example": "susan.smith@gmail.com" }, "acquisitionCampaign": { "maxLength": 300, "minLength": 0, "type": "string", "description": "The campaign that acquired the email address.", "example": "JTV.com PopUp" }, "referrerMetadata": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The URL of the referring application.", "example": "http://www.jtv.com/on/demandware.store/Sites-jtv-Site/default/Marketing-SignUp?null" }, "requestDate": { "type": "string", "description": "The date/time the information was collected by the client.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "phoneNumber": { "pattern": "^[\\d]{10,11}+$", "type": "string", "description": "The 10-digit sms phone number of the person requesting the subscription.", "example": "6155841898" }, "isMarketingSmsOptedIn": { "type": "boolean", "description": "Opt in for Email subscriptions." }, "isMarketingEmailOptedIn": { "type": "boolean", "description": "Opt in for Email subscriptions." }, "enterpriseAccountId": { "maxLength": 256, "minLength": 0, "type": "string", "description": "The external system customer identifier, if any", "example": "EXT12345678" }, "site": { "type": "string", "example": "JTV_COM" } }, "xml": { "name": "promotionalSubscriptionRequest" } }, "ContactService_SubscriptionResponse": { "required": [ "createDate", "subscriptionId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "subscriptionId": { "type": "string", "description": "The unique subscription id.", "example": "SUB9981234" }, "createDate": { "type": "string", "description": "The date the subscription queue record was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "subscriptionResponse" } }, "ContactService_GameShowMarketingSubscriptionRequest": { "required": [ "acquisitionCampaign", "emailAddress", "referrerMetadata", "requestDate", "subscriptionType" ], "type": "object", "properties": { "subscriptionType": { "type": "string", "description": "Required. The type of subscription.", "example": "email", "enum": [ "EMAIL" ] }, "emailAddress": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The subscription target email address.", "example": "susan.smith@gmail.com" }, "acquisitionCampaign": { "maxLength": 300, "minLength": 0, "type": "string", "description": "The campaign that acquired the email address.", "example": "JTV.com PopUp" }, "referrerMetadata": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The URL of the referring application.", "example": "http://www.jtv.com/on/demandware.store/Sites-jtv-Site/default/Marketing-SignUp?null" }, "requestDate": { "type": "string", "description": "The date/time the information was collected by the client.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "gameShowMarketingSubscriptionRequest" } }, "ContactService_PromotionalMarketingSubscriptionRequest": { "required": [ "acquisitionCampaign", "emailAddress", "referrerMetadata", "requestDate", "subscriptionType" ], "type": "object", "properties": { "subscriptionType": { "type": "string", "description": "Required. The type of subscription.", "example": "email", "enum": [ "EMAIL" ] }, "emailAddress": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The subscription target email address.", "example": "susan.smith@gmail.com" }, "acquisitionCampaign": { "maxLength": 300, "minLength": 0, "type": "string", "description": "The campaign that acquired the email address.", "example": "JTV.com PopUp" }, "referrerMetadata": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The URL of the referring application.", "example": "http://www.jtv.com/on/demandware.store/Sites-jtv-Site/default/Marketing-SignUp?null" }, "requestDate": { "type": "string", "description": "The date/time the information was collected by the client.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "promotionalMarketingSubscriptionRequest" } }, "ContactService_BackInStockTransactionalSubscriptionRequest": { "required": [ "emailAddress", "expirationDate", "lastName", "requestDate", "requesterSubscriptionKey", "subscriptionType", "variantId" ], "type": "object", "properties": { "subscriptionType": { "type": "string", "description": "Required. The type of subscription.", "example": "email", "enum": [ "EMAIL" ] }, "variantId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]+(.[0-9]+)?)?", "type": "string", "description": "Required. Letters and numbers with an optional dash followed by the size with a max length of 10 characters. Example: [DQK998-12.5]", "example": "DQK998-7" }, "expirationDate": { "type": "string", "description": "Required. The date/time of the subscription expiration date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "firstName": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Optional. The first name of the person requesting the subscription.", "example": "Susan" }, "lastName": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Required. The last name of the person requesting the subscription.", "example": "Smith" }, "emailAddress": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Required. The email address of the person requesting the subscription.", "example": "susan.smith@gmail.com" }, "requesterSubscriptionKey": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The requesters unique subscription key.", "example": "susan.smith@gmail.com" }, "requestDate": { "type": "string", "description": "The date/time the information was collected by the client.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "backInStockTransactionalSubscriptionRequest" } }, "CountryService_Country": { "required": [ "countryDisplayName", "countryIso2Code", "countryIso3Code", "countryIsoName", "countryIsoNumeric", "hasStateProvinces" ], "type": "object", "properties": { "countryDisplayName": { "maxLength": 85, "minLength": 0, "type": "string", "description": "Country Display Name", "example": "United States" }, "countryIsoName": { "maxLength": 85, "minLength": 0, "type": "string", "description": "ISO standard short name", "example": "United States of America" }, "countryIso2Code": { "type": "string", "description": "ISO 3166 standard alpha-2 country code", "example": "US" }, "countryIso3Code": { "type": "string", "description": "ISO 3166 standard alpha-3 country code", "example": "USA" }, "countryIsoNumeric": { "type": "string", "description": "ISO 3166 standard numeric country code", "example": "840" }, "hasStateProvinces": { "type": "boolean", "description": "Has State/Province Flag" } }, "description": "Country with States or Provinces Representation", "xml": { "name": "Country" } }, "CountryService_GetCountryListResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "countryList": { "type": "array", "description": "List of Country", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CountryService_Country" } } }, "xml": { "name": "countryListResponse" } }, "CountryService_GetStateProvinceListResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "stateProvinceList": { "type": "array", "description": "A list of StateProvinces", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CountryService_StateProvince" } } }, "xml": { "name": "getStateProvinceListResponse" } }, "CountryService_StateProvince": { "required": [ "administrativeArea", "subdivisionCategory", "subdivisionDisplayName", "subdivisionIsoCode", "subdivisionIsoName" ], "type": "object", "properties": { "subdivisionDisplayName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "State or province display name", "example": "Tennessee" }, "subdivisionIsoName": { "maxLength": 150, "minLength": 0, "type": "string", "description": "ISO 3166-2 standard subdivision name", "example": "Tennessee" }, "subdivisionCategory": { "maxLength": 100, "minLength": 0, "type": "string", "description": "ISO 3166-2 standard subdivision category", "example": "state" }, "administrativeArea": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Local administrative area name", "example": "TN" }, "subdivisionIsoCode": { "maxLength": 10, "minLength": 0, "type": "string", "description": "ISO 3166-2 state or province (subdivision) code", "example": "US-TN" } }, "description": "States or Provinces Representation", "xml": { "name": "StateOrProvince" } }, "CuratorProductListings_GetCuratorProductListingsResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalProductCount": { "type": "integer", "description": "The total number of products in the system", "format": "int32" }, "totalStyleCount": { "type": "integer", "description": "The total number of styles in the system", "format": "int32" }, "filteredProductCount": { "type": "integer", "description": "The total number of products that matched the filters", "format": "int32" }, "filteredStyleCount": { "type": "integer", "description": "The total number of styles that matched the filters", "format": "int32" }, "productListingFilters": { "$ref": "#/components/schemas/CuratorProductListings_ProductListingFilters" }, "productListings": { "type": "array", "description": "The Curator Product Listing", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_ProductListing" } } }, "xml": { "name": "getCuratorProductListingsResponse" } }, "CuratorProductListings_ProductListing": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "productNumber": { "type": "string", "description": "Product Number" }, "productType": { "type": "string", "description": "Product Type" }, "initialCreationDate": { "type": "string", "description": "Product Initial Creation Date", "format": "date-time" }, "styleCount": { "type": "integer", "description": "Product Style Count", "format": "int32" }, "productListingPartner": { "$ref": "#/components/schemas/CuratorProductListings_ProductListingPartner" }, "productListingShop": { "$ref": "#/components/schemas/CuratorProductListings_ProductListingShop" }, "styleListings": { "type": "array", "description": "Collection of Product Style Listings", "xml": { "name": "productStyleListings", "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorStyleListings_ProductListingStyle" } } }, "description": "The Curator Product Listing", "xml": { "name": "productListing" } }, "CuratorProductListings_ProductListingAddress": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "addressId": { "type": "string", "description": "Address ID" }, "addressLine1": { "type": "string", "description": "Address Line 1" }, "addressLine2": { "type": "string", "description": "Address Line 2" }, "addressLine3": { "type": "string", "description": "Address Line 3" }, "city": { "type": "string", "description": "Address City" }, "state": { "type": "string", "description": "Address State Province" }, "postalCode": { "type": "string", "description": "Address Postal Code" }, "country": { "type": "string", "description": "Address Country" } }, "description": "Partner Inventory Address", "xml": { "name": "productListingPartner" } }, "CuratorProductListings_ProductListingFilters": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "listingStatuses": { "type": "array", "description": "Service Code", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingStatus" } }, "serviceOfferings": { "type": "array", "xml": { "name": "ServiceOfferings", "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingService" } }, "fulfillmentServiceOfferings": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingService" } }, "productTypes": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingProductType" } }, "lookStyleRates": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingRate" } }, "assortmentStyleRates": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingRate" } }, "starRatings": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "integer", "format": "int32", "xml": { "name": "starRating" } } } }, "description": "The filter options to further reduce the filtered set", "xml": { "name": "ProductListingFilters" } }, "CuratorProductListings_ProductListingPartner": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerNumber": { "type": "string", "description": "Partner Number" }, "partnerId": { "type": "string", "description": "Partner Unique Identifier" }, "partnerName": { "type": "string", "description": "Partner Name" }, "businessAddress": { "$ref": "#/components/schemas/CuratorProductListings_ProductListingAddress" }, "inventoryAddress": { "$ref": "#/components/schemas/CuratorProductListings_ProductListingAddress" } }, "description": "Product Listing Partner", "xml": { "name": "productListingPartner" } }, "CuratorProductListings_ProductListingShop": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopId": { "type": "string", "description": "Shop ID" }, "shopNumber": { "type": "string", "description": "Shop ID" }, "shopDisplayName": { "type": "string", "description": "Shop ID" } }, "description": "Product Listing Shop Profile", "xml": { "name": "productListingShop" } }, "CuratorProductListings_StyleListingFeaturedMetrics": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "lookLineCount": { "type": "integer", "description": "The number of times this style is used in a curated look.", "format": "int32" }, "assortmentLineCount": { "type": "integer", "description": "The number of times this style is used in a curated assortment.", "format": "int32" }, "listLineCount": { "type": "integer", "description": "The number of times this style is used in a curated list.", "format": "int32" } }, "description": "Style Listing Feature Metrics", "xml": { "name": "StyleListingFeaturedMetrics" } }, "CuratorProductListings_StyleListingProductType": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "code": { "type": "string", "description": "Product Type Code" }, "name": { "type": "string", "description": "Product Type Name" }, "description": { "type": "string", "description": "Product Type Description" } }, "xml": { "name": "StyleListingProductType" } }, "CuratorProductListings_StyleListingRate": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "code": { "type": "string", "description": "Style Listing Rate Code" }, "name": { "type": "string", "description": "Style Listing Rate Name" }, "description": { "type": "string", "description": "Style Listing Rate Description" }, "rate": { "type": "number", "description": "Style Listing Rate", "format": "double" }, "styleListingRateMethod": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingRateMethod" }, "styleListingRateType": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingRateType" } }, "description": "Style Listing Rates", "xml": { "name": "StyleListingRate" } }, "CuratorProductListings_StyleListingRateMethod": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "code": { "type": "string", "description": "Style Listing Rate Method Code" }, "name": { "type": "string", "description": "Style Listing Rate Method Name" }, "description": { "type": "string", "description": "Style Listing Rate Method Description" } }, "description": "Style Listing Rate Method", "xml": { "name": "StyleListingMethod" } }, "CuratorProductListings_StyleListingRateType": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "code": { "type": "string", "description": "Style Listing Rate Type Code" }, "name": { "type": "string", "description": "Style Listing Rate Type Name" }, "description": { "type": "string", "description": "Style Listing Rate Type Description" } }, "description": "Style Listing Rate Type", "xml": { "name": "StyleListingType" } }, "CuratorProductListings_StyleListingRatings": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "averageRating": { "type": "number", "description": "Style Average Rating" }, "starRating": { "type": "integer", "description": "Style Star Rating", "format": "int32" }, "numberOfReviews": { "type": "integer", "description": "Style Number of Reviews", "format": "int32" } }, "description": "Style Listing Ratings", "xml": { "name": "StyleListingRatings" } }, "CuratorProductListings_StyleListingService": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "code": { "type": "string", "description": "Service Code" }, "name": { "type": "string", "description": "Service Name" }, "description": { "type": "string", "description": "Service Description" } }, "description": "Style Listing Fulfillment Service", "xml": { "name": "StyleListingService" } }, "CuratorProductListings_StyleListingStatus": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "code": { "type": "string", "description": "Status Code" }, "name": { "type": "string", "description": "Status Name" }, "description": { "type": "string", "description": "Status Description" } }, "description": "Style Listing Status", "xml": { "name": "StyleListingStatus" } }, "CuratorStyleListings_ProductListingStyle": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingId": { "type": "string", "description": "Style ID" }, "styleNumber": { "type": "string", "description": "Style Number" }, "styleImageUrl": { "type": "string", "description": "Style Image URL" }, "titleDescription": { "type": "string", "description": "Style Title Description" }, "supplierItemNumber": { "type": "string", "description": "Style Supplier Item Number" }, "skuCount": { "type": "integer", "description": "Style SKU Count", "format": "int32" }, "availableToSell": { "type": "integer", "description": "Style Available To Sell Quantity", "format": "int32" }, "basePrice": { "type": "number", "description": "Style Base Price", "format": "double" }, "discountPrice": { "type": "number", "description": "Style Discount Price", "format": "double" }, "sellingPrice": { "type": "number", "description": "Style Selling Price", "format": "double" }, "styleListingStatus": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingStatus" }, "styleListingStatusClassification": { "type": "string", "description": "Style Listing Status Classification" }, "styleListingEligibility": { "type": "string", "description": "Style Listing Eligibility" }, "styleListingRatings": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingRatings" }, "styleListingService": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingService" }, "styleListingFulfillmentService": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingService" }, "styleListingFeaturedMetrics": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingFeaturedMetrics" }, "positionOrdinal": { "type": "integer", "description": "Style Listing Position Ordinal", "format": "int32" }, "styleListingRates": { "type": "array", "description": "Style Listing Rates", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CuratorProductListings_StyleListingRate" } } }, "description": "Collection of Product Style Listings", "xml": { "name": "productListingStyle" } }, "CustomerProfileService_CreateCustomerAddressResponse": { "required": [ "addressId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "addressId": { "type": "string", "description": "The customer unique enterprise address id" } }, "xml": { "name": "createCustomerAddressResponse" } }, "CustomerProfileService_CreateCustomerAddress": { "required": [ "addressLineOne", "city", "countryCode", "firstName", "lastName", "postalCode", "state" ], "type": "object", "properties": { "addressLineOne": { "maxLength": 35, "minLength": 1, "type": "string", "description": "First line of the address", "example": "9600 Parkside Drive" }, "addressLineTwo": { "maxLength": 35, "minLength": 0, "type": "string", "description": "Optional second line of the address", "example": "ATTN: Information Technology" }, "city": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Address State or Province Abbreviation", "example": "TN" }, "countryCode": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Address State or Province Abbreviation", "example": "US" }, "postalCode": { "pattern": "^[a-zA-Z][0-9][a-zA-Z] [0-9][a-zA-Z][0-9]$|^[0-9]{5}$|[0-9]{5}-[0-9]{4}$", "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922-6748" }, "firstName": { "maxLength": 14, "minLength": 1, "type": "string", "description": "First name of the addressee", "example": "Susan" }, "lastName": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Last name of the addressee", "example": "Smith" }, "phone": { "pattern": "^[0-9]{10}$", "type": "string", "description": "Phone number", "example": "6155841898" } }, "description": "The customer address to create", "xml": { "name": "createCustomerAddress" } }, "CustomerProfileService_CreateCustomerAddressRequest": { "required": [ "createCustomerAddress" ], "type": "object", "properties": { "createCustomerAddress": { "$ref": "#/components/schemas/CustomerProfileService_CreateCustomerAddress" } }, "xml": { "name": "createCustomerAddressRequest" } }, "CustomerProfileService_CustomerAddress": { "required": [ "addressId", "addressLineOne", "city", "countryCode", "created", "firstName", "lastName", "postalCode", "state", "usedForShippingOnAnOrder" ], "type": "object", "properties": { "addressLineOne": { "maxLength": 35, "minLength": 1, "type": "string", "description": "First line of the address", "example": "9600 Parkside Drive" }, "addressLineTwo": { "maxLength": 35, "minLength": 0, "type": "string", "description": "Optional second line of the address", "example": "ATTN: Information Technology" }, "city": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Address State or Province Abbreviation", "example": "TN" }, "countryCode": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Address State or Province Abbreviation", "example": "US" }, "postalCode": { "pattern": "^[a-zA-Z][0-9][a-zA-Z] [0-9][a-zA-Z][0-9]$|^[0-9]{5}$|[0-9]{5}-[0-9]{4}$", "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922-6748" }, "firstName": { "maxLength": 14, "minLength": 1, "type": "string", "description": "First name of the addressee", "example": "Susan" }, "lastName": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Last name of the addressee", "example": "Smith" }, "phone": { "pattern": "^[0-9]{10}$", "type": "string", "description": "Phone number", "example": "6155841898" }, "addressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The unique customer address id.", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "created": { "type": "string", "description": "The address creation date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "usedForShippingOnAnOrder": { "type": "boolean", "description": "The particular addressId being used on an order in a given time frame in days." } }, "description": "The customer's address list", "xml": { "name": "customerAddress" } }, "CustomerProfileService_GetCustomerAddressesResponse": { "required": [ "customerAddresses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "customerAddresses": { "type": "array", "description": "The customer's address list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CustomerProfileService_CustomerAddress" } } }, "xml": { "name": "getCustomerAddressesResponse" } }, "CustomerProfileService_GetCustomerAddressResponse": { "required": [ "customerAddress" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "customerAddress": { "$ref": "#/components/schemas/CustomerProfileService_CustomerAddress" } }, "xml": { "name": "getCustomerAddressResponse" } }, "CustomerProfileService_DeleteCustomerAddressResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deleteCustomerAddressResponse" } }, "CustomerProfileService_CustomerPurchaseDefaults": { "required": [ "salesChannelPurchaseDefaultsList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "salesChannelPurchaseDefaultsList": { "type": "array", "description": "The list of Customer Sales Channel Purchase Defaults", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CustomerProfileService_SalesChannelPurchaseDefaults" } } }, "xml": { "name": "customerPurchaseDefaults" } }, "CustomerProfileService_SalesChannelDefaultAddress": { "required": [ "addressId" ], "type": "object", "properties": { "addressId": { "type": "string", "description": "The unique customer address id.", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The default shipping address for this sales channel", "xml": { "name": "salesChannelDefaultAddress" } }, "CustomerProfileService_SalesChannelDefaultPaymentAccount": { "type": "object", "properties": { "paymentAccountId": { "type": "string", "description": "The payment account identifier (UUID).", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The default payment account for this sales channel", "xml": { "name": "salesChannelDefaultPaymentAccount" } }, "CustomerProfileService_SalesChannelPurchaseDefaults": { "required": [ "salesChannelCode" ], "type": "object", "properties": { "salesChannelCode": { "type": "string", "description": "The sales channel code" }, "defaultAddress": { "$ref": "#/components/schemas/CustomerProfileService_SalesChannelDefaultAddress" }, "defaultPaymentAccount": { "$ref": "#/components/schemas/CustomerProfileService_SalesChannelDefaultPaymentAccount" } }, "description": "The Customer Sales Channel Purchase Defaults for the requested channel", "xml": { "name": "salesChannelPurchaseDefaults" } }, "CustomerProfileService_CustomerSalesChannelPurchaseDefaults": { "required": [ "salesChannelPurchaseDefaults" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "salesChannelPurchaseDefaults": { "$ref": "#/components/schemas/CustomerProfileService_SalesChannelPurchaseDefaults" } }, "xml": { "name": "customerSalesChannelPurchaseDefaults" } }, "CustomerProfileService_MergeCustomerDefaultsResponse": { "required": [ "success" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "success": { "type": "boolean", "description": "Was the API call successful?" } }, "xml": { "name": "mergeCustomerDefaultsResponse" } }, "CustomerProfileService_MergeSalesChannelDefaults": { "required": [ "addressId", "paymentAccountId" ], "type": "object", "properties": { "addressId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The default shipping addressId (uuid) for this sales channel", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "paymentAccountId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The default payment account id (uuid) for this sales channel", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "mergeSalesChannelDefaults" } }, "CustomerProfileService_MergeSalesChannelDefaultAddress": { "required": [ "addressId" ], "type": "object", "properties": { "addressId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The default shipping addressId (uuid) for this sales channel" } }, "xml": { "name": "mergeSalesChannelDefaultAddress" } }, "CustomerProfileService_MergeSalesChannelDefaultPaymentAccount": { "required": [ "paymentAccountId" ], "type": "object", "properties": { "paymentAccountId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The default paymentAccountId (uuid) for this sales channel" } }, "xml": { "name": "mergeSalesChannelDefaultPaymentAccount" } }, "CustomerProfileService_UpdateCustomerProfileResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updateCustomerProfileResponse" } }, "CustomerProfileService_ContactAddress": { "required": [ "addressLineOne", "city", "countryCode", "postalCode", "state" ], "type": "object", "properties": { "addressLineOne": { "maxLength": 35, "minLength": 1, "type": "string", "description": "First line of the address", "example": "9600 Parkside Drive" }, "addressLineTwo": { "maxLength": 35, "minLength": 0, "type": "string", "description": "Optional second line of the address", "example": "ATTN: Information Technology" }, "city": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Address State or Province Abbreviation", "example": "TN" }, "countryCode": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Address State or Province Abbreviation", "example": "US" }, "postalCode": { "pattern": "^[a-zA-Z][0-9][a-zA-Z] [0-9][a-zA-Z][0-9]$|^[0-9]{5}$|[0-9]{5}-[0-9]{4}$", "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922-6748" } }, "description": "Customer contact address. Optional UNLESS the contact address has already be defined for a customer", "xml": { "name": "contactAddress" } }, "CustomerProfileService_PhoneNumber": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "pattern": "^[0-9]{10}$", "type": "string", "description": "Customer phone number. Note that JTV currently only accepts 10 digit phone numbers, which will work for all North American Dialing Plan compliant countries, Mexico and any others that meet this requirement.", "example": "6155841898" }, "extension": { "pattern": "^[0-9]{1,4}$", "type": "string", "description": "Optional phone extension", "example": "6155" } }, "description": "Customer phone", "xml": { "name": "phoneNumber" } }, "CustomerProfileService_UpdateCustomerProfile": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 14, "minLength": 1, "type": "string", "description": "Customer first name", "example": "Susan" }, "lastName": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Customer last name", "example": "Smith" }, "phone": { "$ref": "#/components/schemas/CustomerProfileService_PhoneNumber" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "Customer email address", "example": "susan.smith@gmail.com" }, "contactAddress": { "$ref": "#/components/schemas/CustomerProfileService_ContactAddress" } }, "description": "The customer profile information to update", "xml": { "name": "updateCustomerProfile" } }, "CustomerProfileService_UpdateCustomerProfileRequest": { "required": [ "updateCustomerProfile" ], "type": "object", "properties": { "updateCustomerProfile": { "$ref": "#/components/schemas/CustomerProfileService_UpdateCustomerProfile" }, "externalCustomerId": { "maxLength": 256, "minLength": 0, "type": "string", "description": "The external system customer identifier, if any", "example": "EXT12345678" } }, "xml": { "name": "updateCustomerProfileRequest" } }, "CustomerProfileService_CustomerProfile": { "required": [ "accountId", "accountStatus", "accountType", "created", "customerId", "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 14, "minLength": 1, "type": "string", "description": "Customer first name", "example": "Susan" }, "lastName": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Customer last name", "example": "Smith" }, "phone": { "$ref": "#/components/schemas/CustomerProfileService_PhoneNumber" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "Customer email address", "example": "susan.smith@gmail.com" }, "contactAddress": { "$ref": "#/components/schemas/CustomerProfileService_ContactAddress" }, "accountId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The unique customer identifier", "example": "5886786" }, "customerId": { "pattern": "^[1-9][0-9]{0,8}$", "type": "string", "description": "The unique customer identifier", "example": "5886786" }, "accountType": { "type": "string", "description": "Customer account type", "example": "REGULAR", "enum": [ "REGULAR", "WEB_GUEST", "MARKETPLACES", "EMPLOYEE" ] }, "accountStatus": { "type": "string", "description": "Customer account status", "example": "ACTIVE", "enum": [ "ACTIVE", "CLOSED", "SUSPENDED" ] }, "created": { "type": "string", "description": "The account creation date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The customer profile", "xml": { "name": "customerProfileCommon" } }, "CustomerProfileService_GetCustomerProfileListResponse": { "required": [ "customers" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "customers": { "type": "array", "description": "The customer profile list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CustomerProfileService_CustomerProfile" } } }, "xml": { "name": "customerProfileListResponse" } }, "CustomerProfileService_GetCustomerProfileResponse": { "required": [ "customer", "customerAddresses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "customer": { "$ref": "#/components/schemas/CustomerProfileService_CustomerProfile" }, "customerAddresses": { "type": "array", "description": "The customer's address list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CustomerProfileService_CustomerAddress" } } }, "xml": { "name": "customerProfileResponse" } }, "CustomerProfileService_CreateCustomerProfileResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "customerId": { "type": "string", "description": "The customer's unique enterprise customer id" }, "accountId": { "type": "string", "description": "The customer's unique UUID" } }, "xml": { "name": "createCustomerProfileResponse" } }, "CustomerProfileServiceCreateCustomerProfile": { "required": [ "accountType", "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 14, "minLength": 1, "type": "string", "description": "Customer first name", "example": "Susan" }, "lastName": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Customer last name", "example": "Smith" }, "phone": { "$ref": "#/components/schemas/CustomerProfileService_PhoneNumber" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "Customer email address", "example": "susan.smith@gmail.com" }, "contactAddress": { "$ref": "#/components/schemas/CustomerProfileService_ContactAddress" }, "accountType": { "type": "string", "description": "Customer account type", "example": "REGULAR", "enum": [ "REGULAR", "WEB_GUEST", "MARKETPLACES", "EMPLOYEE" ] } }, "description": "Customer resource representation.", "xml": { "name": "createCustomerProfile" } }, "CustomerProfileService_CreateCustomerProfileRequest": { "required": [ "createCustomerProfile", "externalCustomerId" ], "type": "object", "properties": { "externalCustomerId": { "maxLength": 256, "minLength": 0, "type": "string", "description": "The external system customer identifier, if any", "example": "EXT12345678" }, "createCustomerProfile": { "$ref": "#/components/schemas/CustomerProfileServiceCreateCustomerProfile" }, "uuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The *optional* identity provider's UUID for clients with the ANY role", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createCustomerProfileRequest" } }, "CustomerReferralCodeService_CreateReferralCodeResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "referralCode": { "pattern": "^[0-9a-zA-Z]{10}$", "type": "string", "description": "The unique referral code.", "example": "W9348M11LD" }, "referralLink": { "type": "string", "description": "The unique referral link.", "example": "https://www.jtv.com/refer?referralcode=W9348M11LD&mcid=XRAF02018" } }, "xml": { "name": "createReferralCodeResponse" } }, "CustomerReferralCodeService_CreateReferralCodeRequest": { "required": [ "customerId" ], "type": "object", "properties": { "customerId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The unique customer identifier", "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } }, "xml": { "name": "createReferralCodeRequest" } }, "CustomerReferralCodeService_GetReferralCodeResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "referralCode": { "pattern": "^[0-9a-zA-Z]{10}$", "type": "string", "description": "The unique referral code.", "example": "W9348M11LD" }, "referralLink": { "type": "string", "description": "The unique referral link.", "example": "https://www.jtv.com/refer?referralcode=W9348M11LD&mcid=XRAF02018" }, "active": { "type": "boolean", "description": "Parameter to show if the referral code is active", "example": false }, "accountId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The UUID customer identifier", "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" }, "deactivationDate": { "type": "string", "description": "The date of deactivation of referral code. Will be present only if the referral code is inactive", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deactivationReasonCode": { "type": "string", "description": "Deactivation reason code. Will be present only if the referral code is inactive", "example": "CUSTOMER_SUSPENDED" } }, "xml": { "name": "getReferralCodeResponse" } }, "CustomerReferralCodeService_DeleteReferralCodeResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deleteReferralCodeResponse" } }, "CustomerReferralValidationService_PolicyExecution": { "required": [ "message", "resultCode", "severity", "type" ], "type": "object", "properties": { "resultCode": { "type": "string", "description": "The result code of the policy execution. Values common to all policy types are 'PASSED', 'NOT_APPLICABLE', 'UNABLE_TO_DETERMINE' and 'INVALID'. Values are added as new policies are implemented. See confluence for the current list of policy-specific result code values.", "example": "FAILED" }, "message": { "type": "string", "description": "A short message describing the policy violation", "example": "Referral code is not active" }, "severity": { "type": "string", "description": "Severity level that indicates how serious a policy violation is. Current values are 'NONE', 'INFO', 'WARN', 'ERROR' and 'INVALID'", "example": "NONE" }, "type": { "type": "string", "description": "The type of customer referral policy that was executed. Values are added as new policies are implemented. See confluence for current list of potential values.", "example": "REFERRAL_CODE_NOT_ACTIVE" } }, "description": "The list of customer referral policy execution results", "xml": { "name": "policyExecution" } }, "CustomerReferralValidationService_ValidateCustomerReferralResponse": { "required": [ "hasErrors", "policyExecutions" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "policyExecutions": { "type": "array", "description": "The list of customer referral policy execution results", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CustomerReferralValidationService_PolicyExecution" } }, "hasErrors": { "type": "boolean", "description": "Top-level flag that indicates whether any of the policy executions contain error severity responses" } }, "xml": { "name": "validateCustomerReferralResponse" } }, "CustomerReferralValidationService_ValidateCustomerReferralRequest": { "required": [ "referralCode" ], "type": "object", "properties": { "referralCode": { "pattern": "^[0-9a-zA-Z]{10}$", "type": "string", "description": "The sponsor referral code", "example": "W9348M11LD" }, "customerId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The unique customer identifier", "example": "f2747a8a-c61f-4285-aeda-75c63a3550b9" } }, "xml": { "name": "validateCustomerReferralRequest" } }, "InstallmentBillingSummaryService_InstallmentBillingPlanDelinquentSummary": { "required": [ "delinquentAmount", "delinquentInstallments", "delinquentOldestDaysPastDue", "delinquentPlans" ], "type": "object", "properties": { "delinquentAmount": { "type": "number", "description": "The delinquent amount", "example": 156.89 }, "delinquentPlans": { "type": "integer", "description": "The number of delinquent plans", "format": "int32", "example": 2 }, "delinquentInstallments": { "type": "integer", "description": "The number of delinquent installments", "format": "int32", "example": 4 }, "delinquentOldestDaysPastDue": { "type": "integer", "description": "The oldest number of days past due", "format": "int32", "example": 8 } }, "description": "The delinquent installment summary", "xml": { "name": "installmentBillingPlanDelinquentSummary" } }, "InstallmentBillingSummaryService_InstallmentBillingPlanRangeSummary": { "required": [ "endDate", "installmentAmount", "installmentCount", "paymentDescription", "startDate" ], "type": "object", "properties": { "startDate": { "type": "string", "description": "The range start date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "endDate": { "type": "string", "description": "The range end date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "installmentAmount": { "type": "number", "description": "The installment amount", "example": 26.89 }, "installmentCount": { "type": "integer", "description": "The installment count", "format": "int32", "example": 3 }, "paymentDescription": { "type": "string", "description": "The payment description", "example": "VISA Exp. 08/20" } }, "description": "The last installment summary", "xml": { "name": "installmentBillingPlanRangeSummary" } }, "InstallmentBillingSummaryService_InstallmentBillingPlanSummary": { "required": [ "activePlans", "deferredBalance", "installmentsRemaining", "totalOutstanding" ], "type": "object", "properties": { "totalOutstanding": { "type": "number", "description": "The total outstanding amount", "example": 39.56 }, "activePlans": { "type": "integer", "description": "The number of active installment billing plans", "format": "int32", "example": 23 }, "installmentsRemaining": { "type": "integer", "description": "The number of outstanding installments", "format": "int32", "example": 15 }, "deferredBalance": { "type": "number", "description": "The remaining balance of deferred installment payments ", "example": 156.89 } }, "description": "The installment summary", "xml": { "name": "installmentBillingPlanSummary" } }, "InstallmentBillingSummaryService_InstallmentBillingSummaryResponse": { "required": [ "currencyCode", "delinquentInstallmentSummary", "inactiveLineTimeBuckets", "inactivePlanTimeBuckets", "installmentSummary", "lastInstallmentSummary", "nextInstallmentSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "currencyCode": { "type": "string", "description": "The currency code in effect for response", "example": "USD", "enum": [ "USD" ] }, "installmentSummary": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlanSummary" }, "nextInstallmentSummary": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlanRangeSummary" }, "lastInstallmentSummary": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlanRangeSummary" }, "delinquentInstallmentSummary": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlanDelinquentSummary" }, "inactivePlanTimeBuckets": { "type": "array", "description": "The list of inactive installment billing plan time buckets", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingTimeBucket" } }, "inactiveLineTimeBuckets": { "type": "array", "description": "The list of inactive installment billing line time buckets", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingTimeBucket" } } }, "xml": { "name": "installmentBillingSummaryResponse" } }, "InstallmentBillingSummaryService_InstallmentBillingTimeBucket": { "required": [ "description", "endDate", "name", "numberOfRecords", "rank", "startDate" ], "type": "object", "properties": { "rank": { "type": "integer", "description": "The bucket rank", "format": "int32", "example": 3 }, "name": { "type": "string", "description": "The bucket name", "example": "90-days" }, "description": { "type": "string", "description": "The bucket description", "example": "90 Days [33]" }, "numberOfRecords": { "type": "integer", "description": "The number of records in the bucket", "format": "int32", "example": 33 }, "startDate": { "type": "string", "description": "The bucket start date", "format": "date-time", "example": "2017-04-15T00:00:00-04:00" }, "endDate": { "type": "string", "description": "The bucket end date", "format": "date-time", "example": "2017-07-15T00:00:00-04:00" } }, "description": "The list of inactive installment billing line time buckets", "xml": { "name": "installmentBillingTimeBucket" } }, "InstallmentBillingSummaryService_InstallmentBillingLinePayMethod": { "required": [ "description", "paymentStatus", "paymentSummary" ], "type": "object", "properties": { "description": { "type": "string", "description": "The Payment Method Description", "example": "MC (**1234) Exp. 06/18" }, "paymentStatus": { "type": "string", "description": "The payment status", "example": "Funds Secured" }, "paymentSummary": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPaymentSummary" } }, "description": "The list of installment billing line's payment methods", "xml": { "name": "installmentBillingLinePayMethod" } }, "InstallmentBillingSummaryService_InstallmentBillingPaymentSummary": { "required": [ "lastFour", "paymentMethodUuid", "paymentTypeCode" ], "type": "object", "properties": { "paymentMethodUuid": { "type": "string", "description": "The payment method UUID", "example": "7037b59e-9ba9-4230-89cb-4d4d7bb7ce5c" }, "paymentTypeCode": { "type": "string", "description": "The payment type code", "example": "CC", "enum": [ "CC", "BD", "ER", "PC", "MO", "OT", "JC", "EF", "PP", "PA", "BL", "GC", "INVALID" ] }, "lastFour": { "maxLength": 4, "minLength": 4, "type": "string", "description": "The last four digits of the customer's account number.", "example": "1234" } }, "description": "The payment summary", "xml": { "name": "installmentBillingPaymentSummary" } }, "InstallmentBillingSummaryService_InstallmentBillingPlan": { "required": [ "balanceRemaining", "billingLineListSize", "billingLines", "imageId", "imageUrl", "installmentsRemaining", "masterId", "nextInstallmentAmount", "nextInstallmentDueDate", "orderDate", "orderNo", "orderRef", "planState", "planStateDescription", "productDescription", "productId", "productSize" ], "type": "object", "properties": { "planState": { "type": "string", "description": "The state of the installment billing plan", "example": "CURRENT", "enum": [ "PENDING_SCHEDULE", "CURRENT", "COMPLETE", "PRECOLLECTIONS_1", "PRECOLLECTIONS_2", "ELIGIBLE_FOR_COLLECTIONS", "CANCELLED", "UNCOLLECTIBLE", "INTERNAL_COLLECTIONS_EXHAUSTED", "SCHEDULED_FOR_COLLECTIONS", "IN_COLLECTIONS" ] }, "planStateDescription": { "type": "string", "description": "The installment billing plan state description", "example": "Current" }, "nextInstallmentDueDate": { "type": "string", "description": "The due date of the next installment", "format": "date-time", "example": "2017-07-14T06:00:00-04:00" }, "nextInstallmentAmount": { "type": "number", "description": "The amount of the next installment", "example": 32.39 }, "installmentsRemaining": { "type": "integer", "description": "The number of installments remaining", "format": "int32", "example": 2 }, "balanceRemaining": { "type": "number", "description": "The unpaid amount of installments remaining ", "example": 64.78 }, "imageId": { "type": "string", "description": "The product image ID", "example": "2945854" }, "imageUrl": { "type": "string", "description": "The product image URL", "example": "http://loadimage.jewelry.acn/loadimage/loadimage.aspx?cgid=2945854" }, "masterId": { "type": "string", "description": "The product master ID", "example": "3588213" }, "productId": { "type": "string", "description": "The product SKU ID", "example": "PWN300W-36" }, "productDescription": { "type": "string", "description": "The product description", "example": "S/S 11-12MM RD WHITE GRANDE CULT FWP NCK / 36\" / CLR/SHP/SZ VRS" }, "productSize": { "type": "string", "description": "The product size", "example": "36.0" }, "orderDate": { "type": "string", "description": "The order date", "format": "date-time", "example": "2017-04-13T18:52:40-04:00" }, "orderNo": { "type": "string", "description": "The order number", "example": "120443028" }, "orderRef": { "type": "string", "description": "The order reference number", "example": "120443028" }, "billingLineListSize": { "type": "integer", "description": "The billing line list size", "format": "int32", "example": 2 }, "billingLines": { "type": "array", "description": "The list of billing line details", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlanDetail" } } }, "description": "A list of Installment Billing Plans matching the request parameters", "xml": { "name": "installmentBillingPlan" } }, "InstallmentBillingSummaryService_InstallmentBillingPlanDetail": { "required": [ "dueDate", "installmentAmount", "installmentNumber", "paidDate", "paymentMethodListSize", "paymentMethods", "paymentSummaries", "paymentSummariesListSize", "scheduledDate", "status", "statusDescription" ], "type": "object", "properties": { "installmentNumber": { "type": "integer", "description": "The installment number", "format": "int32", "example": 1 }, "dueDate": { "type": "string", "description": "The installment due date", "format": "date-time", "example": "2017-05-26T09:41:35-04:00" }, "scheduledDate": { "type": "string", "description": "The installment scheduled date", "format": "date-time", "example": "2017-05-26T09:41:35-04:00", "xml": { "name": "scheduleDate" } }, "status": { "type": "string", "description": "The installment billing line status", "example": "COLLECTED" }, "statusDescription": { "type": "string", "description": "The installment billing line status description", "example": "Paid" }, "paidDate": { "type": "string", "description": "The installment paid date", "format": "date-time", "example": "2017-05-26T12:38:04-04:00" }, "installmentAmount": { "type": "number", "description": "The installment amount", "example": 19.02 }, "paymentSummariesListSize": { "type": "integer", "description": "The payment summaries list size", "format": "int32" }, "paymentSummaries": { "type": "array", "description": "The list of payment summaries", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPaymentSummary" } }, "paymentMethodListSize": { "type": "integer", "description": "The payment methods list size", "format": "int32" }, "paymentMethods": { "type": "array", "description": "The list of installment payment methods", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLinePayMethod" } } }, "description": "The list of billing line details", "xml": { "name": "installmentBillingPlanDetail" } }, "InstallmentBillingSummaryService_InstallmentBillingPlansResponse": { "required": [ "currencyCode", "endIndex", "numberOfPages", "numberOfRecords", "pageNumber", "pageSize", "plans", "plansListSize", "startIndex" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "currencyCode": { "type": "string", "description": "The currency code in effect for response", "example": "USD", "enum": [ "USD" ] }, "startIndex": { "type": "integer", "description": "The starting record index of the returned list", "format": "int32" }, "endIndex": { "type": "integer", "description": "The ending record index of the returned list", "format": "int32" }, "pageNumber": { "type": "integer", "description": "The page number of the returned list", "format": "int32" }, "pageSize": { "type": "integer", "description": "The page size (number of records) of the returned list", "format": "int32" }, "numberOfRecords": { "type": "integer", "description": "The total number of records", "format": "int32" }, "numberOfPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "plansListSize": { "type": "integer", "description": "The plans list size", "format": "int32" }, "plans": { "type": "array", "description": "A list of Installment Billing Plans matching the request parameters", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingPlan" } } }, "xml": { "name": "installmentBillingPlansResponse" } }, "InstallmentBillingSummaryService_InstallmentBillingLineDetail": { "required": [ "amount", "dueDate", "imageId", "imageUrl", "masterId", "numberOfPayments", "orderId", "orderLineItemId", "paymentMethods", "paymentMethodsListSize", "paymentNumber", "productDescription", "skuId", "status", "transitionDate" ], "type": "object", "properties": { "dueDate": { "type": "string", "description": "The installment billing line amount due date", "format": "date-time", "example": "2016-04-27T08:40:53-04:00" }, "status": { "type": "string", "description": "The installment billing line status", "example": "Paid", "enum": [ "Pending", "Scheduled", "Paid", "Cancelled", "Delinquent" ] }, "transitionDate": { "type": "string", "description": "The installment billing line status transition date", "format": "date-time", "example": "2016-04-27T12:22:47-04:00" }, "amount": { "type": "number", "description": "The installment billing line amount", "example": 37.98 }, "paymentNumber": { "type": "integer", "description": "The installment billing line payment number", "format": "int32", "example": 2 }, "numberOfPayments": { "type": "integer", "description": "The number of payments", "format": "int32", "example": 5 }, "imageId": { "type": "string", "description": "The product's image ID", "example": "3160441" }, "imageUrl": { "type": "string", "description": "The product's image URL", "example": "http://loadimage.jewelry.acn/loadimage/loadimage.aspx?cgid=3160441" }, "masterId": { "type": "string", "description": "The product's master ID", "example": "3845098" }, "skuId": { "type": "string", "description": "The product's sku ID", "example": "APL123" }, "productDescription": { "type": "string", "description": "The products description", "example": "S/S 9-10MM CULT TAHITIAN PRL WRAP BANGLE CLRS/SHPS/SZS VRY" }, "orderId": { "type": "string", "description": "The installment billing line's order ID", "example": "109673323", "xml": { "name": "orderID" } }, "orderLineItemId": { "type": "string", "description": "The installment billing line's order line item ID", "example": "109673323" }, "paymentMethods": { "type": "array", "description": "The list of installment billing line's payment methods", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLinePayMethod" } }, "paymentMethodsListSize": { "type": "integer", "description": "The payment method list size", "format": "int32" } }, "description": "A list of Installment Billing Line Detail matching the request parameters", "xml": { "name": "installmentBillingLineDetail" } }, "InstallmentBillingSummaryService_InstallmentBillingLinesResponse": { "required": [ "billingLineListSize", "billingLines", "currencyCode", "endIndex", "numberOfPages", "numberOfRecords", "pageNumber", "pageSize", "startIndex" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "currencyCode": { "type": "string", "description": "The currency code in effect for response", "example": "USD", "enum": [ "USD" ] }, "startIndex": { "type": "integer", "description": "The starting record index of the returned list", "format": "int32" }, "endIndex": { "type": "integer", "description": "The ending record index of the returned list", "format": "int32" }, "pageNumber": { "type": "integer", "description": "The page number of the returned list", "format": "int32" }, "pageSize": { "type": "integer", "description": "The page size (number of records) of the returned list", "format": "int32" }, "numberOfRecords": { "type": "integer", "description": "The total number of records", "format": "int32" }, "numberOfPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "billingLineListSize": { "type": "integer", "description": "The billing line list size", "format": "int32", "example": 2 }, "billingLines": { "type": "array", "description": "A list of Installment Billing Line Detail matching the request parameters", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingSummaryService_InstallmentBillingLineDetail" } } }, "xml": { "name": "installmentBillingLinesResponse" } }, "InstallmentBillingValidationService_AppraisalService": { "required": [ "quantity", "serviceSkuId", "unitAmount" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [APPRAISAL]", "example": "APPRAISAL" }, "unitAmount": { "type": "number", "description": "The appraisal unit amount", "example": 9.99 }, "quantity": { "minimum": 1, "type": "integer", "description": "The service affected quantity", "format": "int32", "example": 1 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_Discount" } } } }, "InstallmentBillingValidationService_CalculatedPaymentPlanItem": { "required": [ "amount", "futurePayment" ], "type": "object", "properties": { "futurePayment": { "type": "boolean", "description": "Indicates if this payment is a future payment or if it is the initial payment due. Should only ever be one initial payment", "example": true }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The installment payment amount", "example": 49.99 } }, "description": "The installment billing payment plan as calculated by the enterprise." }, "InstallmentBillingValidationService_Discount": { "required": [ "amount", "code", "isUnitAmount" ], "type": "object", "properties": { "code": { "pattern": "^[\\S]{1,10}$", "type": "string", "description": "The discount code", "example": "FREESHIP" }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The discount unit amount in USD", "example": 6.99 }, "isUnitAmount": { "type": "boolean", "description": "The discount amount is a line item unit amount -- TRUE means the amount will be multiplied by the line item quantity", "example": false } }, "description": "Line Item Discounts" }, "InstallmentBillingValidationService_InstallmentBillingDetails": { "required": [ "code", "initialPaymentAmount", "installmentBillingAlgorithm" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The line item installment billing plan code", "example": "5_30_0" }, "initialPaymentAmount": { "type": "number", "description": "The payment amount to be collected for the FIRST installment for this line item.", "example": 9.99 }, "installmentBillingAlgorithm": { "maxLength": 400, "minLength": 0, "type": "string", "description": "Code to indicate how to calculate the installment billing plan", "example": "INSTALLMENT_BILLING_PLAN_ALG_V1", "enum": [ "INSTALLMENT_BILLING_PLAN_ALG_V1", "INSTALLMENT_BILLING_PLAN_ALG_V2", "INSTALLMENT_BILLING_PLAN_ALG_V3" ] } }, "description": "The installment billing details" }, "InstallmentBillingValidationService_InstallmentBillingOrderValidationResponse": { "required": [ "generalPolicyExecutions", "hasErrors", "lineItemPolicyExecutions", "paymentPolicyExecutions" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "generalPolicyExecutions": { "type": "array", "description": "The list of installment billing policy execution results", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PolicyExecution" } }, "lineItemPolicyExecutions": { "type": "array", "description": "The list of installment billing policy execution results", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_LineItemPolicyExecution" } }, "paymentPolicyExecutions": { "type": "array", "description": "The list of installment billing policy execution results", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PaymentPolicyExecution" } }, "hasErrors": { "type": "boolean", "description": "Top-level flag that indicates whether any of the policy executions contain error severity responses" } }, "xml": { "name": "installmentBillingOrderValidationResponse" } }, "InstallmentBillingValidationService_LineItem": { "required": [ "baseUnitAmount", "installmentBillingDetails", "quantity", "skuId" ], "type": "object", "properties": { "skuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[A-Z0-9]+(.[A-Z0-9]+)?)?", "type": "string", "description": "The enterprise sku id", "example": "DQK998-6.5" }, "baseUnitAmount": { "type": "number", "description": "The pricing offer base unit amount in USD prior to any discounts", "example": 49.99 }, "pricingOffer": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PricingOfferDetails" }, "quantity": { "minimum": 1, "type": "integer", "description": "The requested quantity", "format": "int32", "example": 2 }, "taxAmount": { "type": "number", "description": "The tax amount in USD", "example": 4.59 }, "installmentBillingDetails": { "$ref": "#/components/schemas/InstallmentBillingValidationService_InstallmentBillingDetails" }, "productService": { "$ref": "#/components/schemas/InstallmentBillingValidationService_ProductService" }, "discounts": { "uniqueItems": true, "type": "array", "description": "Line Item Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_Discount" } }, "shippingCharges": { "$ref": "#/components/schemas/InstallmentBillingValidationService_ShippingCharges" } }, "description": "The non-empty collection of order line items" }, "InstallmentBillingValidationService_LineItemPolicyExecution": { "required": [ "calculatedPaymentPlanItems", "lineItem", "policyExecutions" ], "type": "object", "properties": { "lineItem": { "$ref": "#/components/schemas/InstallmentBillingValidationService_LineItem" }, "policyExecutions": { "type": "array", "description": "The installment billing validation policy executions for this line item", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PolicyExecution" } }, "calculatedPaymentPlanItems": { "type": "array", "description": "The installment billing payment plan as calculated by the enterprise.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_CalculatedPaymentPlanItem" } } }, "description": "The list of installment billing policy execution results" }, "InstallmentBillingValidationService_PaymentPolicyExecution": { "required": [ "paymentMethodId", "policyExecutions" ], "type": "object", "properties": { "policyExecutions": { "type": "array", "description": "The installment billing validation policy executions for this payment method", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PolicyExecution" } }, "paymentMethodId": { "type": "string", "description": "The enterprise payment method id", "example": "123456" } }, "description": "The list of installment billing policy execution results" }, "InstallmentBillingValidationService_PolicyExecution": { "required": [ "message", "resultCode", "severity", "type" ], "type": "object", "properties": { "resultCode": { "type": "string", "description": "The result code of the policy execution. Values common to all policy types are 'PASSED', 'NOT_APPLICABLE', 'UNABLE_TO_DETERMINE' and 'INVALID'. Values are added as new policies are implemented. See confluence for the current list of policy-specific result code values.", "example": "PASSED" }, "message": { "type": "string", "description": "A short message describing the policy violation" }, "severity": { "type": "string", "description": "Severity level that indicates how serious a policy violation is. Current values are 'NONE', 'INFO', 'WARN', 'ERROR' and 'INVALID'", "example": "NONE" }, "type": { "type": "string", "description": "The type of installment billing policy that was executied. Values are added as new policies are implemented. See confluence for current list of potential values.", "example": "INSTALLMENT_BILLING_OFFER_SCHEDULE" } }, "description": "The installment billing validation policy executions for this payment method", "xml": { "name": "policyExecution" } }, "InstallmentBillingValidationService_PricingOfferDetails": { "required": [ "pricingOfferCode", "pricingOfferPrice", "pricingOfferScheduleId" ], "type": "object", "properties": { "pricingOfferCode": { "maxLength": 30, "minLength": 1, "type": "string", "description": "The effective pricing offer code [BASE_PRICE, HOLIDAY_PRICE, EMPLOYEE_PRICE, etc.]", "example": "HOLIDAY_PRICE" }, "pricingOfferScheduleId": { "type": "integer", "description": "The effective pricing offer schedule id", "format": "int32", "example": 1234587 }, "pricingOfferPrice": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The pricing offer unit amount in USD", "example": 49.99 } }, "description": "The pricing offer in affect for this purchase" }, "InstallmentBillingValidationService_ProductService": { "type": "object", "properties": { "appraisal": { "$ref": "#/components/schemas/InstallmentBillingValidationService_AppraisalService" }, "sizing": { "$ref": "#/components/schemas/InstallmentBillingValidationService_SizingService" }, "warranty": { "$ref": "#/components/schemas/InstallmentBillingValidationService_WarrantyService" } }, "description": "The line item applied product services" }, "InstallmentBillingValidationService_ShippingCharges": { "required": [ "baseAmount" ], "type": "object", "properties": { "baseAmount": { "type": "number", "description": "The JTV shipping base amount in USD", "example": 6.99 }, "expeditedAmount": { "type": "number", "description": "The JTV shipping expedited amount in USD", "example": 18.99 }, "oversizedAmount": { "type": "number", "description": "The JTV oversized shipping amount in USD", "example": 12.99 }, "internationalAmount": { "type": "number", "description": "The JTV international shipping amount in USD", "example": 12.99 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Shipping Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_ShippingDiscount" } } }, "description": "The line item shipping charges" }, "InstallmentBillingValidationService_ShippingDiscount": { "required": [ "amount", "code" ], "type": "object", "properties": { "code": { "pattern": "^[\\S]{1,10}$", "type": "string", "description": "The shipping discount code", "example": "FREESHIP" }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The shipping discount amount in USD", "example": 6.99 } }, "description": "Shipping Discounts" }, "InstallmentBillingValidationService_SizingService": { "required": [ "serviceSkuId", "unitAmount" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [SIZE10]", "example": "SIZE10" }, "unitAmount": { "type": "number", "description": "The sizing unit amount", "example": 9.99 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_Discount" } } } }, "InstallmentBillingValidationService_WarrantyService": { "required": [ "quantity", "serviceSkuId", "unitAmount" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [JSWARR1234]", "example": "JSWARR1234" }, "unitAmount": { "type": "number", "description": "The warranty unit amount", "example": 9.99 }, "quantity": { "minimum": 1, "type": "integer", "description": "The service affected quantity", "format": "int32", "example": 1 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_Discount" } } } }, "InstallmentBillingValidationService_CreditCardPayment": { "required": [ "paymentMethodId" ], "type": "object", "properties": { "paymentMethodId": { "pattern": "([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The order credit card payments" }, "InstallmentBillingValidationService_GiftCardPayment": { "required": [ "paymentMethodId" ], "type": "object", "properties": { "paymentMethodId": { "pattern": "([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The order gift card payments" }, "InstallmentBillingValidationService_InstallmentBillingOrderValidationRequest": { "required": [ "currencyCode", "lineItems", "referenceDate" ], "type": "object", "properties": { "referenceDate": { "type": "string", "description": "The date of record to evaluate installment billing policies for. Usually set to start of checkout flow to avoid term schedules expiring after add to cart but before place order.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "currencyCode": { "type": "string", "description": "The order currency code. Should ALWAYS be USD for now", "example": "USD", "enum": [ "USD" ] }, "lineItems": { "type": "array", "description": "The non-empty collection of order line items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_LineItem" } }, "creditCardPayments": { "uniqueItems": true, "type": "array", "description": "The order credit card payments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_CreditCardPayment" } }, "giftCardPayments": { "uniqueItems": true, "type": "array", "description": "The order gift card payments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/InstallmentBillingValidationService_GiftCardPayment" } }, "preferredAccountPayment": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PreferredAccountPayment" }, "paypalPayment": { "$ref": "#/components/schemas/InstallmentBillingValidationService_PayPalPayment" } }, "xml": { "name": "installmentBillingOrderValidationRequest" } }, "InstallmentBillingValidationService_PayPalPayment": { "type": "object", "description": "The order paypal payment" }, "InstallmentBillingValidationService_PreferredAccountPayment": { "required": [ "paymentMethodId", "promotionCode" ], "type": "object", "properties": { "paymentMethodId": { "pattern": "([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "promotionCode": { "type": "string", "description": "The promotion code", "example": "PA-30" } }, "description": "The order preferred account payment" }, "OrderCancelService_CancellationResponse": { "required": [ "cancellationDate" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "cancellationDate": { "type": "string", "description": "The date of the order cancellation.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "cancellationResponse" } }, "OrderCancelService_CancellationRequest": { "required": [ "cancellationReasonId" ], "type": "object", "properties": { "cancellationReasonId": { "pattern": "^[1-9][0-9]{0,8}$", "type": "string", "description": "The unique enterprise cancellation reason id.", "example": "200" } }, "xml": { "name": "cancellationRequest" } }, "OrderCancelService_CancellationReason": { "required": [ "description", "id" ], "type": "object", "properties": { "id": { "maxLength": 38, "minLength": 1, "type": "string", "description": "The unique cancellation reason id.", "example": "200" }, "description": { "maxLength": 38, "minLength": 1, "type": "string", "description": "The cancellation reason description", "example": "I changed my mind" } }, "description": "The SET of enterprise cancellation reasons.", "xml": { "name": "cancellationReason" } }, "OrderCancelService_CancellationReasonResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "cancellationReasons": { "uniqueItems": true, "type": "array", "description": "The SET of enterprise cancellation reasons.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCancelService_CancellationReason" } } }, "xml": { "name": "cancellationReasonResponse" } }, "OrderCreationService_OrderCreationResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderId": { "type": "string" }, "paymentProblem": { "type": "boolean" } }, "xml": { "name": "orderCreationResponse" } }, "OrderCreationService_AffirmPayment": { "required": [ "amount", "billingAddressId", "checkoutId", "installmentBillingIndicator", "loanTransactionId", "responseDate" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "checkoutId": { "type": "string", "description": "Checkout id provided by affirm" }, "loanTransactionId": { "type": "string", "description": "Loan Transaction Id provided by affirm" }, "amount": { "type": "number", "description": "Amount provided by affirm" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "responseDate": { "type": "string", "description": "Response date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The affirm payment for this line item" }, "OrderCreationService_ApplePayPayment": { "required": [ "billingAddressId", "braintreeV2Transaction", "installmentBillingIndicator" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "braintreeV2Transaction": { "$ref": "#/components/schemas/OrderCreationService_Braintree_Transaction_V2" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The Apple payment for this line item" }, "OrderCreationService_AppraisalService": { "required": [ "quantity", "serviceSkuId", "unitAmount" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [APPR6789]", "example": "APPR6789" }, "unitAmount": { "type": "number", "description": "The appraisal unit amount", "example": 9.99 }, "quantity": { "minimum": 1, "type": "integer", "description": "The service affected quantity", "format": "int32", "example": 1 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_Discount" } } } }, "OrderCreationService_Braintree_ApplePayDetails_V2": { "type": "object", "properties": { "cardHolderName": { "type": "string", "description": "Name of the card holder", "example": "Bob Smith" }, "cardType": { "type": "string", "description": "cardType", "example": "Visa" }, "cardLastFour": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Last four digits on the card number", "example": "1234" }, "cardExpirationMonth": { "maxLength": 2, "minLength": 1, "type": "string", "description": "Numerical month of year the card expires", "example": "02" }, "cardExpirationYear": { "maxLength": 4, "minLength": 4, "type": "string", "description": "Year the card expires", "example": "2035" } }, "description": "This model class corresponds to the class BraintreeApplePayV2Details in the Braintree Java SDK 2.77.0 but it has been simplified.", "xml": { "name": "applePayPalV2Details" } }, "OrderCreationService_Braintree_GooglePayDetails_V2": { "type": "object", "properties": { "googleTransactionId": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "Braintree Google Pay transaction Id", "example": "AH2Ejte4WAsgfDgPhOnYvX43uigLmUxDtzkMz6Bx8c" }, "cardType": { "type": "string", "description": "cardType", "example": "Visa" }, "cardLastFour": { "maxLength": 4, "minLength": 1, "type": "string", "description": "Last four digits on the card number", "example": "1234" }, "cardExpirationMonth": { "maxLength": 2, "minLength": 1, "type": "string", "description": "Numerical month of year the card expires", "example": "02" }, "cardExpirationYear": { "maxLength": 4, "minLength": 4, "type": "string", "description": "Year the card expires", "example": "2035" } }, "description": "This model class corresponds to the class BraintreeGooglePayV2Details in the Braintree Java SDK 2.77.0 but it has been simplified.", "xml": { "name": "braintreeGooglePayV2Details" } }, "OrderCreationService_Braintree_PayPalDetails_V2": { "required": [ "authorizationId", "captureId", "debugId", "payerEmail", "payerId", "paymentId", "token", "transactionFeeAmount", "transactionFeeCurrencyIsoCode" ], "type": "object", "properties": { "token": { "maxLength": 500, "minLength": 1, "type": "string", "description": "Token", "example": "8wxtgn" }, "payerEmail": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Payer Email", "example": "savula-facilitator@dminc.com" }, "paymentId": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Payment ID", "example": "PAY-7JV89510J6958714DLKGILHY" }, "authorizationId": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Authorization ID", "example": "8MS78041XU600124H" }, "debugId": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Debug ID", "example": "2bac9987278de" }, "payerId": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Payer ID", "example": "M44WN9AF7SHR8" }, "captureId": { "maxLength": 500, "minLength": 1, "type": "string", "description": "Capture ID", "example": "8MS78041XU600124H" }, "transactionFeeAmount": { "maxLength": 50, "minLength": 1, "type": "string", "description": "BraintreeTransaction Fee Amount", "example": "4.85" }, "transactionFeeCurrencyIsoCode": { "maxLength": 50, "minLength": 1, "type": "string", "description": "BraintreeTransaction Fee Currency ISO Code", "example": "USD" } }, "description": "This model class corresponds to the class BraintreePayPalV2Details in the Braintree Java SDK 2.77.0 but it has been simplified.", "xml": { "name": "braintreePayPalV2Details" } }, "OrderCreationService_Braintree_Transaction_V2": { "required": [ "amount", "createdAt", "id", "processorResponseCode", "processorResponseText", "status" ], "type": "object", "properties": { "id": { "maxLength": 50, "minLength": 1, "type": "string", "description": "BraintreeTransaction ID", "example": "f26xn4e3" }, "status": { "type": "string", "description": "BraintreeTransaction Status", "example": "SETTLING", "enum": [ "AUTHORIZATION_EXPIRED", "AUTHORIZED", "AUTHORIZING", "FAILED", "GATEWAY_REJECTED", "PROCESSOR_DECLINED", "SETTLED", "SETTLEMENT_CONFIRMED", "SETTLEMENT_DECLINED", "SETTLEMENT_PENDING", "SETTLING", "SUBMITTED_FOR_SETTLEMENT", "UNRECOGNIZED", "VOIDED" ] }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "Transaction Amount", "example": 156.99 }, "processorResponseCode": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Processor Response Code", "example": "1000" }, "processorResponseText": { "maxLength": 500, "minLength": 1, "type": "string", "description": "Processor Response Text", "example": "Approved" }, "processorSettlementResponseCode": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Processor Settlement Response Code", "example": "4000" }, "processorSettlementResponseText": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Processor Settlement Response Text", "example": "Confirmed" }, "createdAt": { "type": "string", "description": "Created At", "format": "date-time", "example": "2018-02-20T20:31:30-07:00" }, "updatedAt": { "type": "string", "description": "Updated At", "format": "date-time", "example": "2018-02-20T20:31:30-07:00" }, "braintreeApplePayV2Details": { "$ref": "#/components/schemas/OrderCreationService_Braintree_ApplePayDetails_V2" }, "braintreeGooglePayV2Details": { "$ref": "#/components/schemas/OrderCreationService_Braintree_GooglePayDetails_V2" }, "braintreePayPalV2Details": { "$ref": "#/components/schemas/OrderCreationService_Braintree_PayPalDetails_V2" } }, "description": "This model class corresponds to the class Transaction in the Braintree Java SDK 2.77.0 but it has been simplified.", "xml": { "name": "braintreeV2Transaction" } }, "OrderCreationService_CreditCardPayment": { "required": [ "installmentBillingIndicator" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The payment amount. Decimal value between 0.00 and 99999.99 inclusive in USD", "example": 99.99 }, "paymentMethodId": { "pattern": "([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "litle0910OnlineResponse": { "$ref": "#/components/schemas/OrderCreationService_Litle0910OnlineResponse" }, "authorizationId": { "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The credit card payments" }, "OrderCreationService_Discount": { "required": [ "amount", "code", "description", "isUnitAmount" ], "type": "object", "properties": { "description": { "maxLength": 80, "minLength": 1, "pattern": "^.*{1,80}$", "type": "string", "description": "The discount description", "example": "Free-Shipping Discount" }, "code": { "pattern": "^[\\S]{1,10}$", "type": "string", "description": "The discount code", "example": "FREESHIP" }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The discount amount in USD", "example": 6.99 }, "isUnitAmount": { "type": "boolean", "description": "The discount amount is a line item unit amount? -- TRUE means the amount will be multiplied by the associated quantity", "example": false } }, "description": "Line Item Discounts" }, "OrderCreationService_GiftCardPayment": { "required": [ "amount", "billingAddressId", "installmentBillingIndicator", "paymentMethodId" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The payment amount. Decimal value between 0.00 and 99999.99 inclusive in USD", "example": 99.99 }, "paymentMethodId": { "pattern": "([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "litle0910OnlineResponse": { "$ref": "#/components/schemas/OrderCreationService_Litle0910OnlineResponse" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The gift card payments" }, "OrderCreationService_GooglePayPayment": { "required": [ "billingAddressId", "braintreeV2Transaction", "installmentBillingIndicator" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "braintreeV2Transaction": { "$ref": "#/components/schemas/OrderCreationService_Braintree_Transaction_V2" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The Apple payment for this line item" }, "OrderCreationService_InstallmentBillingDetails": { "required": [ "code", "installmentBillingAlgorithm" ], "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The line item installment billing plan code", "example": "6_30_0" }, "installmentBillingAlgorithm": { "maxLength": 400, "minLength": 0, "type": "string", "description": "Code to indicate how to calculate the installment billing plan", "example": "INSTALLMENT_BILLING_PLAN_ALG_V1", "enum": [ "INSTALLMENT_BILLING_PLAN_ALG_V1", "INSTALLMENT_BILLING_PLAN_ALG_V2", "INSTALLMENT_BILLING_PLAN_ALG_V3" ] } }, "description": "The installment billing details" }, "OrderCreationService_LineItem": { "required": [ "baseUnitAmount", "quantity", "shippingCharges", "shippingDetails", "skuId", "taxAmount" ], "type": "object", "properties": { "clientLineItemId": { "maxLength": 36, "minLength": 0, "type": "string", "description": "The client system's line item -- if any", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "skuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[A-Z0-9]+(.[A-Z0-9]+)?)?$", "type": "string", "description": "The enterprise sku id", "example": "DQK998-6" }, "baseUnitAmount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The pricing offer base unit amount in USD prior to any discounts", "example": 49.99 }, "pricingOffer": { "$ref": "#/components/schemas/OrderCreationService_PricingOfferDetails" }, "quantity": { "minimum": 1, "type": "integer", "description": "The requested quantity", "format": "int32", "example": 2 }, "reservationId": { "pattern": "^[1-9][0-9]{0,9}$", "type": "string", "description": "The reservation id", "example": "123456789" }, "showId": { "pattern": "^$|^[1-9][0-9]{0,9}$", "type": "string", "description": "The show id to credit for the sale", "example": "123456789" }, "taxAmount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The tax amount in USD", "example": 4.59 }, "shippingDetails": { "$ref": "#/components/schemas/OrderCreationService_ShippingDetails" }, "shippingCharges": { "$ref": "#/components/schemas/OrderCreationService_ShippingCharges" }, "installmentBillingDetails": { "$ref": "#/components/schemas/OrderCreationService_InstallmentBillingDetails" }, "productService": { "$ref": "#/components/schemas/OrderCreationService_ProductService" }, "discounts": { "uniqueItems": true, "type": "array", "description": "Line Item Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_Discount" } }, "isGiftItem": { "type": "boolean", "description": "A boolean indicating if this is a giftItem.", "example": true }, "giftMessage": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "A gift message for the giftItem", "example": "Happy Holidays" }, "productRecipeUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The product recipe Uuid for a custom order" } }, "description": "The non-empty collection of order line items" }, "OrderCreationService_Litle0910AuthorizationResponse": { "required": [ "fraudResult", "id", "litleTxnId", "message", "orderId", "postDate", "reportGroup", "response", "responseTime" ], "type": "object", "properties": { "id": { "maxLength": 20, "minLength": 1, "type": "string", "description": "The Litle authorization response id", "example": "124058857-2200" }, "reportGroup": { "maxLength": 12, "minLength": 1, "type": "string", "description": "The Litle authorization response report group", "example": "395700032300" }, "litleTxnId": { "maxLength": 100, "minLength": 1, "type": "string", "description": "The Litle transaction id", "example": "82921727584911723" }, "orderId": { "maxLength": 30, "minLength": 1, "type": "string", "description": "The order id", "example": "EXTERNAL-1234567890" }, "response": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The Litle response code", "example": "000" }, "responseTime": { "type": "string", "description": "The response time", "format": "date-time", "example": "2001-07-04T00:00:00-07:00" }, "postDate": { "type": "string", "description": "The post date", "format": "date-time", "example": "2001-07-04T00:00:00-07:00" }, "message": { "maxLength": 250, "minLength": 1, "type": "string", "description": "The response message", "example": "Approved" }, "authCode": { "maxLength": 10, "minLength": 0, "type": "string", "description": "The response authorization code. Not required for failed attempts.", "example": "123457" }, "fraudResult": { "$ref": "#/components/schemas/OrderCreationService_Litle0910FraudResult" }, "accountUpdater": { "$ref": "#/components/schemas/OrderCreationService_Litle0910XmlAAUResponseElement" }, "giftCardResponse": { "$ref": "#/components/schemas/OrderCreationService_Litle0910GiftCardResponse" } }, "description": "The Litle Authorization Result" }, "OrderCreationService_Litle0910FraudResult": { "required": [ "avsResult", "cardValidationResult" ], "type": "object", "properties": { "avsResult": { "maxLength": 3, "minLength": 1, "type": "string", "description": "The Address Verification System (AVS) result", "example": "20" }, "cardValidationResult": { "maxLength": 3, "minLength": 1, "type": "string", "description": "The card validation result", "example": "M" } }, "description": "The response fraud result" }, "OrderCreationService_Litle0910GiftCardResponse": { "required": [ "availableBalance" ], "type": "object", "properties": { "availableBalance": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The gift card available balance in USD", "example": 19.99 } }, "description": "The response gift card response" }, "OrderCreationService_Litle0910OnlineResponse": { "required": [ "authorizationResponse", "message", "response", "version" ], "type": "object", "properties": { "response": { "maxLength": 5, "minLength": 1, "type": "string", "description": "The Litle Online Response response code", "example": "0" }, "message": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The Litle Online Response response message", "example": "Valid Format" }, "version": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The Litle Online Response response version", "example": "9.1" }, "authorizationResponse": { "$ref": "#/components/schemas/OrderCreationService_Litle0910AuthorizationResponse" } }, "description": "The gift card payment online authorization result." }, "OrderCreationService_Litle0910XmlAAUResponseElement": { "required": [ "oldExpirationDate", "updatedExpirationDate" ], "type": "object", "properties": { "oldExpirationDate": { "pattern": "^[0-9]{4}$$", "type": "string", "description": "The old expiration date", "example": "0820" }, "updatedExpirationDate": { "pattern": "^[0-9]{4}$$", "type": "string", "description": "The new expiration date", "example": "0820" } }, "description": "The response account update result" }, "OrderCreationService_OrderCreationRequest": { "required": [ "clientOrderDate", "currencyCode", "lineItems" ], "type": "object", "properties": { "clientOrderDate": { "type": "string", "description": "The date the order request was accepted by the client", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "clientOrderNumber": { "maxLength": 30, "minLength": 0, "type": "string", "description": "The client system's order number -- if any", "example": "ORD-1234567890" }, "currencyCode": { "type": "string", "description": "The payment currency code. Should ALWAYS be USD for now", "example": "USD", "xml": { "name": "paymentCurrencyCode" }, "enum": [ "USD" ] }, "creditCardPayments": { "type": "array", "description": "The credit card payments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_CreditCardPayment" } }, "giftCardPayments": { "type": "array", "description": "The gift card payments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_GiftCardPayment" } }, "preferredAccountPayment": { "$ref": "#/components/schemas/OrderCreationService_PreferredAccountPayment" }, "applePayPayment": { "$ref": "#/components/schemas/OrderCreationService_ApplePayPayment" }, "googlePayPayment": { "$ref": "#/components/schemas/OrderCreationService_GooglePayPayment" }, "paypalPayment": { "$ref": "#/components/schemas/OrderCreationService_PayPalPayment" }, "affirmPayment": { "$ref": "#/components/schemas/OrderCreationService_AffirmPayment" }, "lineItems": { "type": "array", "description": "The non-empty collection of order line items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_LineItem" } }, "customerReferralCode": { "maxLength": 10, "minLength": 10, "type": "string", "description": "A code used for referral discount incentive", "example": "CD3STYZBP1" }, "webCustomerSession": { "$ref": "#/components/schemas/OrderCreationService_WebCustomerSession" } }, "xml": { "name": "orderCreationRequest" } }, "OrderCreationService_PayPalPayment": { "required": [ "billingAddressId", "braintreeV2Transaction", "installmentBillingIndicator" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "braintreeV2Transaction": { "$ref": "#/components/schemas/OrderCreationService_Braintree_Transaction_V2" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The paypal payment for this line item" }, "OrderCreationService_PreferredAccountPayment": { "required": [ "amount", "billingAddressId", "fallbackTermsUsed", "installmentBillingIndicator", "paymentMethodId" ], "type": "object", "properties": { "installmentBillingIndicator": { "type": "boolean", "description": "Indicates that this payment is to be applied for all future installment billing payments. This is a required field if installment billing option is selected for any line item. Can only be set for a single order payment and may not be set for installment billing ineligible payment methods.", "example": false, "default": false }, "exceptionName": { "maxLength": 300, "minLength": 0, "type": "string", "description": "Max = 300 characters. The fully qualified Java class name of the root cause of the communication exception.", "example": "java.net.ConnectException" }, "exceptionDetails": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Max = 500 characters. Any details about the auth call that you feel is important -- i.e. exception.getMessage()?", "example": "Connection timed out" }, "authTimeMills": { "maximum": 9223372036854775807, "minimum": 0, "type": "integer", "description": "The number of milliseconds elapsed during the payment provider's successful or failed authentication try.", "format": "int64", "example": 34, "default": 0 }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The payment amount. Decimal value between 0.00 and 99999.99 inclusive in USD", "example": 99.99 }, "paymentMethodId": { "pattern": "([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "promotionCode": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The partner promotion code", "example": "000" }, "fallbackTermsUsed": { "type": "boolean", "description": "A boolean stating whether we successful received a promotion disclosure", "example": false }, "synchronyV2AuthorizationResponse": { "$ref": "#/components/schemas/OrderCreationService_SynchronyV2AuthorizationResponse" }, "billingAddressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The enterprise addressId to use for this paymentMethodId", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" } }, "description": "The preferred account payment" }, "OrderCreationService_PricingOfferDetails": { "required": [ "pricingOfferCode", "pricingOfferPrice", "pricingOfferScheduleId" ], "type": "object", "properties": { "pricingOfferCode": { "maxLength": 30, "minLength": 1, "type": "string", "description": "The effective pricing offer code [BASE_PRICE, HOLIDAY_PRICE, EMPLOYEE_PRICE, etc.]", "example": "HOLIDAY_PRICE" }, "pricingOfferScheduleId": { "type": "integer", "description": "The effective pricing offer schedule id", "format": "int32", "example": 1234587 }, "pricingOfferPrice": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The pricing offer unit amount in USD", "example": 49.99 } }, "description": "The pricing offer in affect for this purchase" }, "OrderCreationService_ProductService": { "type": "object", "properties": { "appraisal": { "$ref": "#/components/schemas/OrderCreationService_AppraisalService" }, "sizing": { "$ref": "#/components/schemas/OrderCreationService_SizingService" }, "warranty": { "$ref": "#/components/schemas/OrderCreationService_WarrantyService" }, "setting": { "$ref": "#/components/schemas/OrderCreationService_SettingService" } }, "description": "The line item applied product services" }, "OrderCreationService_SettingService": { "required": [ "serviceSkuId" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [SETTING]", "example": "SETTING" }, "unitAmount": { "type": "number", "description": "The setting unit amount", "example": 0.0 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_Discount" } } } }, "OrderCreationService_ShippingCharges": { "required": [ "baseAmount" ], "type": "object", "properties": { "baseAmount": { "type": "number", "description": "The JTV shipping base amount in USD", "example": 6.99 }, "expeditedAmount": { "type": "number", "description": "The JTV shipping expedited amount in USD", "example": 18.99 }, "oversizedAmount": { "type": "number", "description": "The JTV oversized shipping amount in USD", "example": 12.99 }, "internationalAmount": { "type": "number", "description": "The JTV international shipping amount in USD", "example": 12.99 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Shipping Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_ShippingDiscount" } } }, "description": "The line item shipping charges" }, "OrderCreationService_ShippingDetails": { "required": [ "addressId", "shippingTerms" ], "type": "object", "properties": { "addressId": { "pattern": "(^[1-9][0-9]{0,8}$)|([a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12})", "type": "string", "description": "The unique customer address id.", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "shippingTerms": { "type": "string", "description": "The shipping terms [NEXT_BUSINESS_DAY, TWO_BUSINESS_DAYS, JTV_STANDARD]", "example": "JTV_STANDARD", "enum": [ "JTV_STANDARD", "NEXT_BUSINESS_DAY", "TWO_BUSINESS_DAYS", "THREE_BUSINESS_DAYS" ] } }, "description": "The line item shipping details, overrides the order creation request shipping details" }, "OrderCreationService_ShippingDiscount": { "required": [ "amount", "code", "codeType", "description" ], "type": "object", "properties": { "description": { "maxLength": 80, "minLength": 1, "pattern": "^.*{1,80}$", "type": "string", "description": "The discount description is required", "example": "Free-Shipping Discount" }, "code": { "pattern": "^[\\S]{1,10}|^[0-9]{1,10}$$", "type": "string", "description": "The discount code is required", "example": "FREESHIP" }, "amount": { "maximum": 99999.99, "exclusiveMaximum": false, "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The discount amount in USD is required", "example": 6.99 }, "codeType": { "pattern": "^WEBSITE$|^ENTERPRISE$", "type": "string", "description": "The discount code type is required. WEBSITE or ENTERPRISE ", "example": "1234587" } }, "description": "Shipping Discounts" }, "OrderCreationService_SizingService": { "required": [ "serviceSkuId", "unitAmount" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [SIZE10]", "example": "SIZE10" }, "unitAmount": { "type": "number", "description": "The sizing unit amount", "example": 9.99 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_Discount" } } } }, "OrderCreationService_SynchronyV2AuthorizationResponse": { "required": [ "responseCode", "responseDate" ], "type": "object", "properties": { "responseCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The Synchrony response code", "example": "000" }, "responseMessage": { "maxLength": 200, "minLength": 0, "type": "string", "description": "The response message", "example": "Approved" }, "responseDate": { "type": "string", "description": "The response time", "format": "date-time", "example": "2018-06-13T00:00:00-07:00" }, "providerTransactionId": { "maxLength": 22, "minLength": 0, "type": "string", "description": "The Litle transaction id", "example": "82921727584911723" }, "errors": { "type": "array", "description": "The collection of error responses", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The collection of error responses", "xml": { "name": "error" } } }, "status": { "type": "string", "description": "The synchrony status", "example": "APPROVED" }, "authorizationCode": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Auth Code", "example": "0123456" }, "avsCode": { "maxLength": 12, "minLength": 0, "type": "string", "description": "AVS Code", "example": "X" }, "promoText": { "maxLength": 3000, "minLength": 0, "type": "string", "description": "OFLP Language, promo agreement text" }, "cvv2Result": { "type": "string", "description": "Cvv2 result", "example": "M" } }, "description": "The preferred account payment online authorization result from synchrony. If you have a connection timeout or a socket read timeout or other communication exception during authorization fill in the exceptionName and exceptionMessage elements." }, "OrderCreationService_WarrantyService": { "required": [ "quantity", "serviceSkuId", "unitAmount" ], "type": "object", "properties": { "serviceSkuId": { "pattern": "(?=^.{1,10}$)^[A-Z0-9]+(-[0-9]{1,3}){0,1}$", "type": "string", "description": "The service sku id [JSWARR1234]", "example": "JSWARR1234" }, "unitAmount": { "type": "number", "description": "The warranty unit amount", "example": 9.99 }, "quantity": { "minimum": 1, "type": "integer", "description": "The service affected quantity", "format": "int32", "example": 1 }, "discounts": { "uniqueItems": true, "type": "array", "description": "Service Discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderCreationService_Discount" } } } }, "OrderCreationService_WebCustomerSession": { "required": [ "ipAddress" ], "type": "object", "properties": { "deviceId": { "type": "string", "description": "Device Id", "example": "00000000-89ABCDEF-01234567-89ABCDEF" }, "ipAddress": { "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string", "description": "Ip Address", "example": "255.255.255.255" }, "tealiumVisitorId": { "maxLength": 45, "minLength": 0, "type": "string", "description": "Tealium Visitor Id" } }, "description": "The IP address and Device ID" }, "OrderHistoryService_GetCustomerOrderDetailResponse": { "required": [ "orders", "resultPageSize", "startingRecordIndex", "totalNumberOfRecords" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orders": { "type": "array", "description": "The customer's paged order history list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_Order" } }, "startingRecordIndex": { "type": "integer", "description": "The starting record index for the paged order history list", "format": "int32" }, "resultPageSize": { "type": "integer", "description": "The max number of records included in the paged order history list", "format": "int32", "xml": { "name": "resultsPageSize" } }, "totalNumberOfRecords": { "type": "integer", "description": "The total number of records in the order history list", "format": "int32" } }, "xml": { "name": "getCustomerOrderDetailResponse" } }, "OrderHistoryService_InstallmentBillingPlan": { "required": [ "deferredInstallmentCount", "deferredPaymentAmountInCents", "initialPaymentAmountInCents", "planTotalInCents" ], "type": "object", "properties": { "deferredInstallmentCount": { "type": "integer", "description": "The deferred installment count", "format": "int32", "example": 4 }, "deferredPaymentAmountInCents": { "type": "integer", "description": "The deferred installment payment acount in cents", "format": "int32", "example": 999 }, "initialPaymentAmountInCents": { "type": "integer", "description": "The initial installment payment acount in cents", "format": "int32", "example": 1003 }, "planTotalInCents": { "type": "integer", "description": "The installment plan total in cents", "format": "int32", "example": 4999 } }, "description": "The initial installment billing plan", "xml": { "name": "installmentBillingPlan" } }, "OrderHistoryService_InstallmentBillingPlanState": { "required": [ "code", "customerDescription", "description", "name", "planFilterState" ], "type": "object", "properties": { "code": { "type": "string", "description": "The installment billing plan state code", "example": "COMPLETE" }, "customerDescription": { "type": "string", "description": "The installment billing plan state customer facing description", "example": "Paid" }, "description": { "type": "string", "description": "The installment billing plan state description", "example": "Complete" }, "name": { "type": "string", "description": "The installment billing plan state name", "example": "Complete" }, "planFilterState": { "type": "string", "description": "planFilterState", "example": "INACTIVE" } }, "description": "The installment plan state", "example": "COMPLETE", "xml": { "name": "installmentBillingPlanState" } }, "OrderHistoryService_InstallmentBillingSummary": { "required": [ "balanceRemainingInCents", "currentInstallmentPaymentSummary", "currentPlanTotalInCents", "initialBillingPlan", "installmentTerms", "lastPaymentAmountInCents", "lastPaymentDate", "nextInstallmentAmountInCents", "nextInstallmentDate", "nextInstallmentPaymentSummary", "paymentsRemaining", "planState" ], "type": "object", "properties": { "balanceRemainingInCents": { "type": "integer", "description": "The installment billing plan balance remaining in cents", "format": "int32", "example": 0 }, "currentInstallmentPaymentSummary": { "$ref": "#/components/schemas/OrderHistoryService_OrderPaymentSummary" }, "currentPlanTotalInCents": { "type": "integer", "description": "currentPlanTotalInCents", "format": "int32", "example": 0 }, "initialBillingPlan": { "$ref": "#/components/schemas/OrderHistoryService_InstallmentBillingPlan" }, "installmentTerms": { "$ref": "#/components/schemas/OrderHistoryService_InstallmentBillingTerm" }, "lastPaymentAmountInCents": { "type": "integer", "description": "lastPaymentAmountInCents", "format": "int32", "example": 0 }, "lastPaymentDate": { "type": "string", "description": "The last payment date", "format": "date-time", "example": "2016-12-22T08:30:10-05:00" }, "nextInstallmentAmountInCents": { "type": "integer", "description": "The next installment amount in cents", "format": "int32", "example": 0 }, "nextInstallmentDate": { "type": "string", "description": "The next installment date", "format": "date-time" }, "nextInstallmentPaymentSummary": { "$ref": "#/components/schemas/OrderHistoryService_OrderPaymentSummary" }, "paymentsRemaining": { "type": "integer", "description": "The number of installment payments remaining", "format": "int32", "example": 0 }, "planState": { "$ref": "#/components/schemas/OrderHistoryService_InstallmentBillingPlanState" } }, "description": "Order line item installment billing summary", "example": false, "xml": { "name": "installmentBillingSummary" } }, "OrderHistoryService_InstallmentBillingTerm": { "required": [ "active", "code", "description", "installmentBillingTermsId", "installmentDays", "numInstallments", "offsetDays" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "The installment billing terms active state", "example": true }, "code": { "type": "string", "description": "The installment billing terms code", "example": "5_30_0" }, "description": { "type": "string", "description": "The installment billing terms description", "example": "Stretchpay 5 payable every 30 days" }, "installmentBillingTermsId": { "type": "integer", "description": "The installment billing terms id ", "format": "int32", "example": 41 }, "installmentDays": { "type": "integer", "description": "The installment billing terms installment days", "format": "int32", "example": 30 }, "numInstallments": { "type": "integer", "description": "The installment billing terms number of installments ", "format": "int32", "example": 5 }, "offsetDays": { "type": "integer", "description": "The installment billing terms offset days", "format": "int32", "example": 0 } }, "description": "The installment billing terms", "xml": { "name": "installmentBillingTerms" } }, "OrderHistoryService_Order": { "required": [ "orderHeader", "orderItems" ], "type": "object", "properties": { "orderHeader": { "$ref": "#/components/schemas/OrderHistoryService_OrderHeader" }, "orderItems": { "type": "array", "description": "The order line items in this order", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderItem" } }, "orderPackages": { "type": "array", "description": "The packages in this order", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderPackage" } } }, "description": "The customer's paged order history list", "xml": { "name": "order" } }, "OrderHistoryService_OrderHeader": { "required": [ "hasInstallmentBillingPlan", "headerStatus", "numberOfLineItems", "orderDate", "orderId", "orderOrigination", "orderTotals", "paymentMethods", "paymentSummaries" ], "type": "object", "properties": { "orderId": { "type": "string", "description": "The enterprise order id", "example": "654321" }, "orderOrigination": { "type": "string", "description": "The enterprise order origination identification", "example": "ONLINE" }, "orderDate": { "type": "string", "description": "The enterprise order date", "format": "date-time", "example": "2016-03-28T12:26:21-04:00" }, "headerStatus": { "$ref": "#/components/schemas/OrderHistoryService_OrderStatus" }, "hasInstallmentBillingPlan": { "type": "boolean", "description": "Does the enterprise order have an installment billing plan", "example": false }, "numberOfLineItems": { "type": "integer", "description": "The number of line items in this order", "format": "int32", "example": 5 }, "paymentMethods": { "type": "array", "description": "The payment method list used in this order", "example": "VI", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The payment method list used in this order", "example": "VI", "xml": { "name": "paymentMethod" } } }, "paymentSummaries": { "type": "array", "description": "The payment summaries in this order", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderPaymentSummary" } }, "orderTotals": { "$ref": "#/components/schemas/OrderHistoryService_OrderTotals" } }, "description": "The order header information", "xml": { "name": "orderHeader" } }, "OrderHistoryService_OrderItem": { "required": [ "cancellableStatus", "events", "externalLineItemId", "hasInstallmentBillingPlan", "initialDemandType", "itemNumber", "lineItemStatus", "orderItemInstallmentBillingSummary", "productDescription", "productGroupId", "productId", "sizeNumber", "taxInCents" ], "type": "object", "properties": { "cancellableStatus": { "type": "string", "description": "The order item's available for cancellation status", "example": "NOT_CANCELLABLE" }, "events": { "type": "array", "description": "The order item's associated order placed, order return, order refund and/or order exchange events", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderItemEvent" } }, "initialDemandType": { "type": "string", "description": "The order item's initial demand type", "example": "PHYSICAL_RESERVATION" }, "itemNumber": { "type": "integer", "description": "The order item's unique number", "format": "int32", "example": 108841856 }, "lineItemStatus": { "$ref": "#/components/schemas/OrderHistoryService_OrderStatus" }, "productDescription": { "type": "string", "description": "The order item's product description", "example": "1.75CTW ROUND TANZANITE 18K GOLD OVER SILVER CROSS PENDANT WITH CHAIN" }, "productGroupId": { "type": "integer", "description": "The order item's product group id", "format": "int32", "example": 3836644 }, "productId": { "type": "string", "description": "The order item's product identification", "example": "STZ376" }, "sizeNumber": { "type": "string", "description": "The order item's shipping address", "example": "7.5" }, "taxInCents": { "type": "integer", "description": "The order item's tax amount in cents", "format": "int32", "example": 0 }, "hasInstallmentBillingPlan": { "type": "boolean", "description": "Does the enterprise order item have an installment billing plan", "example": false }, "orderItemInstallmentBillingSummary": { "$ref": "#/components/schemas/OrderHistoryService_InstallmentBillingSummary" }, "externalLineItemId": { "type": "string", "description": "The external line item identifier for deep linking to client website", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "isGiftItem": { "type": "boolean", "description": "A boolean indicating if this is a giftItem.", "example": true }, "giftMessage": { "type": "string", "description": "A gift message for the giftItem", "example": "Happy Holidays" }, "productRecipeUuid": { "type": "string", "description": "The product recipe uuid for a custom product", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "The order line items in this order", "xml": { "name": "orderItem" } }, "OrderHistoryService_OrderItemEvent": { "required": [ "affectedQuantity", "appraisalService", "discounts", "eventDate", "eventKey", "eventStatus", "eventType", "itemTotalInCents", "lineItemProductDiscountInCents", "lineItemServiceDiscountInCents", "lineItemShippingDiscountInCents", "merchantShippingServiceCode", "merchantShippingServiceDescription", "miscInCents", "paymentTotalInCents", "payments", "restockingFeeInCents", "salesOrderTypeName", "services", "shippingChargeInCents", "sizingService", "taxInCents", "unitPriceInCents" ], "type": "object", "properties": { "eventDate": { "type": "string", "description": "The order item event date", "format": "date-time", "example": "2016-03-29T15:34:11-04:00" }, "affectedQuantity": { "type": "integer", "description": "The product quantity affected by the event", "format": "int32", "example": 1 }, "appraisalService": { "type": "boolean", "description": "Is appraisal service allowed?", "example": false }, "discounts": { "type": "array", "description": "The list of order item event discounts", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderItemEventDiscount" } }, "eventKey": { "type": "string", "description": "The event coorelation key", "example": "108841856" }, "payments": { "type": "array", "description": "The order item event payment list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderItemEventPayment" } }, "eventStatus": { "$ref": "#/components/schemas/OrderHistoryService_OrderStatus" }, "eventType": { "type": "string", "description": "The order item event type code", "example": "ORDER_PLACED" }, "itemTotalInCents": { "type": "integer", "description": "The order time event total in cents", "format": "int32", "example": 6195 }, "lineItemProductDiscountInCents": { "type": "integer", "description": "The order time event product discount in cents", "format": "int32", "example": 0 }, "lineItemServiceDiscountInCents": { "type": "integer", "description": "The order time event service discount in cents", "format": "int32", "example": 0 }, "lineItemShippingDiscountInCents": { "type": "integer", "description": "The order time event shipping discount in cents", "format": "int32", "example": -500 }, "merchantShippingServiceCode": { "type": "string", "description": "The merchange shipping service code", "example": "PST1" }, "merchantShippingServiceDescription": { "type": "string", "description": "The merchant shipping service description", "example": "Standard Delivery" }, "miscInCents": { "type": "integer", "description": "The miscellenaous charge in cents", "format": "int32", "example": 0 }, "paymentTotalInCents": { "type": "integer", "description": "The payment total in cents", "format": "int32", "example": 6195 }, "restockingFeeInCents": { "type": "integer", "description": "The restocking fee in cents", "format": "int32", "example": 0 }, "returnOrderTypeName": { "type": "string", "description": "The return order type name" }, "salesOrderTypeName": { "type": "string", "description": "The sales order type name", "example": "Sales Order" }, "services": { "type": "array", "description": "The list of event services", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderItemEventService" } }, "shippingChargeInCents": { "type": "integer", "description": "The shipping charge in cents", "format": "int32", "example": 699 }, "sizingService": { "type": "boolean", "description": "Is the sizing service available?", "example": false }, "taxInCents": { "type": "integer", "description": "The event item tax in cents", "format": "int32", "example": 0 }, "unitPriceInCents": { "type": "integer", "description": "The event item unit price in cents", "format": "int32", "example": 5996 }, "eventShippingAddress": { "$ref": "#/components/schemas/OrderHistoryService_OrderShippingAddress" }, "merchantEstimatedDeliveryDate": { "type": "string", "description": "The merchant estimated delivery date", "format": "date-time", "example": "2016-04-06T00:00:00-04:00" }, "carrierEstimatedDeliveryDate": { "type": "string", "description": "The carrier estimated delivery date", "format": "date-time", "example": "2016-04-06T00:00:00-04:00" }, "merchantShippedDate": { "type": "string", "description": "The merchant shipped date", "format": "date-time", "example": "2016-04-01T00:00:00-04:00" }, "carrierDeliveredFlag": { "type": "boolean", "description": "The carrier delivered flag", "example": true } }, "description": "The order item's associated order placed, order return, order refund and/or order exchange events", "xml": { "name": "orderItemEvent" } }, "OrderHistoryService_OrderItemEventDiscount": { "required": [ "description", "discountType", "extendedPriceInCents", "productGroup", "productName", "quantity", "unitPriceInCents" ], "type": "object", "properties": { "description": { "type": "string", "description": "The discount description", "example": "1.99 Standard Shipping" }, "discountType": { "type": "string", "description": "The discount type", "example": "SHIPPING" }, "extendedPriceInCents": { "type": "integer", "description": "The discount extended price in cents (i.e. Shipping Discount)", "format": "int32", "example": -500 }, "productGroup": { "type": "string", "description": "The discount product group", "example": "COUPONS" }, "productName": { "type": "string", "description": "The discount product name", "example": "SL199STD1" }, "quantity": { "type": "integer", "description": "The discount product quantity", "format": "int32", "example": 1 }, "unitPriceInCents": { "type": "integer", "description": "The discount unit price in cents", "format": "int32", "example": -500 } }, "description": "The list of order item event discounts", "xml": { "name": "orderItemEventDiscount" } }, "OrderHistoryService_OrderItemEventPayment": { "required": [ "authorizationDate", "depositedDate", "paymentKey", "paymentResultState", "paymentState", "paymentStateDescription", "paymentType", "submittedDate", "summary" ], "type": "object", "properties": { "authorizationDate": { "type": "string", "description": "The payment authoriziation date", "format": "date-time", "example": "2016-03-28T16:26:22-04:00" }, "depositedDate": { "type": "string", "description": "The payment deposit date", "format": "date-time", "example": "2016-03-29T14:07:34-04:00" }, "installmentNo": { "type": "integer", "description": "The payment installment number", "format": "int32", "example": 1 }, "paymentKey": { "type": "string", "description": "The payment correlation key", "example": "147189022" }, "paymentResultState": { "type": "string", "description": "The payment result state", "example": "AUTHORIZED" }, "paymentState": { "type": "string", "description": "The payment state", "example": "SETTLEMENT_SCHEDULED" }, "paymentStateDescription": { "type": "string", "description": "The payment state description", "example": "SETTLEMENT_SCHEDULED" }, "paymentTotalInCents": { "type": "integer", "description": "The payment total in cents", "format": "int32" }, "paymentType": { "type": "string", "description": "The payment method type code", "example": "VI" }, "submittedDate": { "type": "string", "description": "The payment submitted date", "format": "date-time", "example": "2016-03-29T14:07:35-04:00" }, "summary": { "$ref": "#/components/schemas/OrderHistoryService_OrderPaymentSummary" }, "installmentState": { "type": "string", "description": "The installment payment state", "example": "NEW" }, "dueDate": { "type": "string", "description": "The installment payment due date", "format": "date-time", "example": "2016-03-29T14:07:35-04:00" } }, "description": "The order item event payment list", "xml": { "name": "orderItemEventPayment" } }, "OrderHistoryService_OrderItemEventService": { "required": [ "description", "extendedPriceInCents", "masterId", "productGroup", "productName", "quantity", "unitPriceInCents" ], "type": "object", "properties": { "description": { "type": "string", "description": "The service description (i.e. JewelSafe, Appraisal, Sizing", "example": "SIZING TO 12" }, "extendedPriceInCents": { "type": "integer", "description": "The service extended price in cents (i.e. Shipping)", "format": "int32", "example": 599 }, "masterId": { "type": "integer", "description": "The service master identification", "format": "int32", "example": 1684806 }, "productGroup": { "type": "string", "description": "The service product group name", "example": "SIZINGS" }, "productName": { "type": "string", "description": "The service product name", "example": "SIZE12" }, "quantity": { "type": "integer", "description": "The service product quantity", "format": "int32", "example": 1 }, "unitPriceInCents": { "type": "integer", "description": "The service product unit price in cents", "format": "int32", "example": 599 } }, "description": "The list of event services", "xml": { "name": "orderItemEventService" } }, "OrderHistoryService_OrderPackage": { "required": [ "carrierCode", "carrierDescription", "packageItems", "serviceDescription" ], "type": "object", "properties": { "carrierCode": { "type": "string", "description": "The order package carrier code", "example": "UPSMI" }, "carrierDescription": { "type": "string", "description": "The order package carrier description", "example": "UPS Mail Innovations" }, "serviceDescription": { "type": "string", "description": "The order package carrier service description", "example": "UPS Mail Innovations Expedited" }, "trackingUrl": { "type": "string", "description": "The order package carrier service description", "example": "http://www.ups.com/WebTracking/processInputRequest?tracknum=" }, "carrierTrackingInfo": { "$ref": "#/components/schemas/OrderHistoryService_OrderPackageTracking" }, "packageItems": { "type": "array", "description": "The order package items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderPackageItem" } } }, "description": "The packages in this order", "xml": { "name": "orderPackage" } }, "OrderHistoryService_OrderPackageItem": { "required": [ "additionalItemFlag", "description", "orderId", "orderLineItemId", "productId", "shippedQuantity" ], "type": "object", "properties": { "additionalItemFlag": { "type": "boolean", "description": "The order package item additional item flag", "example": false }, "description": { "type": "string", "description": "The order package item description", "example": "4 JEWEL SCHOOL STORAGE CONTAINERS, ASRT SHAPES/SIZES" }, "orderLineItemId": { "type": "integer", "description": "The order package item enterprise order line item id", "format": "int32", "example": 108841199 }, "orderId": { "type": "integer", "description": "The order package item enterprise order id", "format": "int32", "example": 108841198 }, "originalOrder": { "type": "integer", "description": "The order package item original order number", "format": "int32", "example": 108841198 }, "productId": { "type": "string", "description": "The order package item unique product identification", "example": "JMKIT532" }, "shippedQuantity": { "type": "integer", "description": "The order package item shipped quantity in this package", "format": "int32", "example": 1 } }, "description": "The order package items", "xml": { "name": "orderPackageItem" } }, "OrderHistoryService_OrderPackageTracking": { "required": [ "carrierCode", "deliveryDate", "packageStatus", "trackingEvents", "trackingNumber" ], "type": "object", "properties": { "carrierCode": { "type": "string", "description": "The order package carrier code", "example": "UPSMI" }, "deliveryDate": { "type": "string", "description": "The order package carrier delivery date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "errorCode": { "type": "string", "description": "The order package tracking request error code", "example": "CALL_TIMED_OUT" }, "packageStatus": { "type": "string", "description": "The order package status code", "example": "NOT_AVAILABLE" }, "trackingEvents": { "type": "array", "description": "The order package carrier code", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderPackageTrackingEvent" } }, "trackingNumber": { "type": "string", "description": "The order package tracking number", "example": "92748901078130553110270000" } }, "description": "The order package carrier tracking information", "xml": { "name": "orderPackageTracking" } }, "OrderHistoryService_OrderPackageTrackingEvent": { "required": [ "eventDate", "eventLocation", "eventStatus" ], "type": "object", "properties": { "eventDate": { "type": "string", "description": "The tracking event date", "format": "date-time", "example": "2016-12-21T08:33:00-04:00" }, "eventLocation": { "type": "string", "description": "The tracking event location", "example": "FLINT, MI 48503" }, "eventStatus": { "type": "string", "description": "The tracking event status", "example": "Out for Delivery" } }, "description": "The order package carrier code", "xml": { "name": "orderPackageTrackingEvent" } }, "OrderHistoryService_OrderPaymentCreditCardType": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The credit card type code", "example": "VI" }, "name": { "type": "string", "description": "The credit card type name", "example": "Visa" }, "creditCardNumberLastFour": { "type": "string", "description": "The payment method type description", "example": "5678" }, "creditCardExpirationDate": { "type": "string", "description": "The payment method type description", "format": "date-time" } }, "description": "The payment method credit card type information", "xml": { "name": "orderCreditCardType" } }, "OrderHistoryService_OrderPaymentMethodType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The payment method type code", "example": "CC" }, "description": { "type": "string", "description": "The payment method type description", "example": "Credit Card Charge" }, "name": { "type": "string", "description": "The payment method type name", "example": "Credit Card" } }, "description": "The payment method type information", "xml": { "name": "orderPaymentMethodType" } }, "OrderHistoryService_OrderPaymentSummary": { "required": [ "orderPaymentMethodType", "paymentMethodId" ], "type": "object", "properties": { "paymentMethodId": { "type": "string", "description": "A lowercase, 36-digit GUID with dashes", "example": "855b302b-1108-cfae-00d9-f28df3ced5e5" }, "orderPaymentMethodType": { "$ref": "#/components/schemas/OrderHistoryService_OrderPaymentMethodType" }, "orderPaymentCreditCardType": { "$ref": "#/components/schemas/OrderHistoryService_OrderPaymentCreditCardType" } }, "description": "The next installment payment summary", "xml": { "name": "orderPaymentSummary" } }, "OrderHistoryService_OrderShippingAddress": { "required": [ "addressLineOne", "city", "countryCode", "postalCode", "state" ], "type": "object", "properties": { "firstName": { "maxLength": 14, "minLength": 0, "type": "string", "description": "First name of the addressee", "example": "Susan" }, "lastName": { "maxLength": 17, "minLength": 0, "type": "string", "description": "Last name of the addressee", "example": "Smith" }, "addressLineOne": { "maxLength": 35, "minLength": 1, "type": "string", "description": "First line of the address", "example": "9600 Parkside Drive" }, "addressLineTwo": { "maxLength": 35, "minLength": 0, "type": "string", "description": "Optional second line of the address", "example": "ATTN: Information Technology" }, "city": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "maxLength": 2, "minLength": 2, "type": "string", "description": "Address State or Province Abbreviation", "example": "TN" }, "countryCode": { "maxLength": 2, "minLength": 2, "type": "string", "description": "Address State or Province Abbreviation", "example": "US" }, "postalCode": { "maxLength": 10, "minLength": 5, "type": "string", "description": "Address postal code number or delivery zone number", "example": "37922-6748" }, "phone": { "pattern": "^[0-9]{10}$", "type": "string", "description": "Phone number", "example": "6155841898" } }, "description": "The event item order shipping address", "xml": { "name": "orderShippingAddress" } }, "OrderHistoryService_OrderStatus": { "type": "object", "properties": { "expectationDate": { "type": "string", "description": "The enterprise order delivery expectation date", "format": "date-time", "example": "2016-04-06T00:00:00-04:00" }, "expectationLabel": { "type": "string", "description": "The enterprise order delivery expectation label", "example": "Estimated Delivery" }, "statusDate": { "type": "string", "description": "The enterprise order status date", "format": "date-time", "example": "2016-03-29T00:00:00-04:00" }, "statusDescription": { "type": "string", "description": "The enterprise order status description", "example": "Shipped" }, "statusLabel": { "type": "string", "description": "The enterprise order status label", "example": "Shipped" }, "statusMarketingDescription": { "type": "string", "description": "The enterprise order status marketing description", "example": "A happy dance is in your near future because your order has shipped." }, "expectationDateTime": { "type": "string", "description": "The enterprise order delivery expectation date and time", "format": "date-time", "example": "2016-04-06T00:00:00-04:00" }, "statusDateTime": { "type": "string", "description": "The enterprise order status date and time", "format": "date-time", "example": "2016-03-29T00:00:00-04:00" } }, "description": "The order line item's status", "xml": { "name": "orderStatus" } }, "OrderHistoryService_OrderTotals": { "required": [ "orderShippingAndHandlingInCents", "orderShippingDiscountInCents", "orderTaxInCents", "orderTotalInCents" ], "type": "object", "properties": { "orderTotalInCents": { "type": "integer", "description": "The enterprise order total in cents", "format": "int32", "example": 6195 }, "orderShippingAndHandlingInCents": { "type": "integer", "description": "The enterprise order shipping and handling in cents", "format": "int32", "example": 6195 }, "orderShippingDiscountInCents": { "type": "integer", "description": "The enterprise order shipping discount in cents", "format": "int32", "example": 6195 }, "orderTaxInCents": { "type": "integer", "description": "The enterprise order tax in cents", "format": "int32", "example": 6195 } }, "description": "The order money totals", "xml": { "name": "orderTotals" } }, "OrderHistoryService_GetCustomerOrderHeaderResponse": { "required": [ "orderHeaders", "resultPageSize", "startingRecordIndex", "totalNumberOfRecords" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderHeaders": { "type": "array", "description": "The customer's paged order header history list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderHeader" } }, "startingRecordIndex": { "type": "integer", "description": "The starting record index for the paged order history list", "format": "int32" }, "resultPageSize": { "type": "integer", "description": "The max number of records included in the paged order history list", "format": "int32", "xml": { "name": "resultsPageSize" } }, "totalNumberOfRecords": { "type": "integer", "description": "The total number of records in the order history list", "format": "int32" } }, "xml": { "name": "getCustomerOrderHeaderResponse" } }, "Item": { "required": [ "brand", "color", "composition", "countryOfOrigin", "cut", "dateOfPurchase", "description", "dimensions", "gemstone", "minedIn", "opticalProperty", "orderId", "productImageCount", "productImageUrl", "purchasePrice", "shape", "size", "sku", "species", "treatment" ], "type": "object", "properties": { "orderId": { "type": "string", "description": "The order id associated to this item", "example": "654321" }, "gemstone": { "type": "string", "description": "The name of the gemstone", "example": "OPAL" }, "species": { "type": "string", "description": "The species of the gemstone", "example": "OPAL" }, "sku": { "type": "string", "description": "The stock keeping unit in JTV", "example": "OP415" }, "opticalProperty": { "type": "string", "description": "The optical property of the gemstone", "example": "PLAY-OF-COLOR" }, "description": { "type": "string", "description": "The description of the gemstone", "example": "Ethiopian opal 7.00ct minimum 18x13mm oval. The gemstone was mined in Ethiopia and cut in India." }, "dateOfPurchase": { "type": "string", "description": "The date of purchase of the gemstone", "format": "date-time" }, "purchasePrice": { "type": "number", "description": "The purchase price of the gemstone", "example": 49.99 }, "brand": { "type": "string", "description": "The brand of the gemstone", "example": "ETHIOPIAN OPAL" }, "color": { "type": "string", "description": "The color of the gemstone", "example": "VARIOUS COLORS" }, "cut": { "type": "string", "description": "The cut of the gemstone", "example": "CABOCHON" }, "shape": { "type": "string", "description": "The shape of the gemstone", "example": "OVAL" }, "size": { "type": "number", "description": "The size (carat weight) of the gemstone", "format": "double", "example": 7 }, "dimensions": { "type": "string", "description": "The dimensions of the gemstone", "example": "18X13 MM" }, "countryOfOrigin": { "type": "string", "description": "The country of origin of the gemstone", "example": "INDIA" }, "minedIn": { "type": "string", "description": "The country the gemstone was mined in", "example": "DJIBOUTI" }, "composition": { "type": "string", "description": "The composition of the gemstone", "example": "NATURAL" }, "treatment": { "type": "string", "description": "The treatment of the gemstone", "example": "NO TREATMENT" }, "productImageUrl": { "type": "string", "description": "The link to the image of the gemstone", "example": "http = //i5.jtv.com/loadimage.aspx?btype=.jpg&cgid=3361353" }, "productImageCount": { "type": "integer", "description": "The count of images of the gemstone", "format": "int32", "example": 1 } }, "description": "The all orders items" }, "OrderHistoryService_OrderHistory": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "The all orders items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/Item" } } }, "description": "The gemstone orders of the customer", "xml": { "name": "orderHistory" } }, "DeprecatedDateType": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "deprecatedDateType" } }, "OrderHistoryService_GetCustomerOrderLineItemDetailResponse": { "required": [ "orderHeader", "orderItems" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderHeader": { "$ref": "#/components/schemas/OrderHistoryService_OrderHeader" }, "orderItems": { "type": "array", "description": "The items in this order id", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/OrderHistoryService_OrderItem" } } }, "xml": { "name": "getCustomerOrderDetailResponse" } }, "OrderReturnLabelService_OrderReturnLabelEmailResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "orderReturnLabelEmailResponse" } }, "OrderReturnLabelService_OrderReturnLabelEmailRequest": { "type": "object", "xml": { "name": "orderReturnLabelEmailRequest" } }, "PartnerAgreementService_AgreementActionType": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Agreement action type unique code" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Agreement action type description" } }, "description": "Partner agreement action type representation.", "xml": { "name": "agreementActionType" } }, "PartnerAgreementService_AgreementMedia": { "type": "object", "properties": { "agreementUrl": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Agreement media URL" }, "mediaType": { "$ref": "#/components/schemas/PartnerAgreementService_AgreementMediaType" } }, "description": "Partner agreement media representation.", "xml": { "name": "agreementMedia" } }, "PartnerAgreementService_AgreementMediaType": { "type": "object", "properties": { "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Media type unique code" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Media type description" } }, "description": "Partner agreement media type representation.", "xml": { "name": "agreementMediaType" } }, "PartnerAgreementService_PartnerAgreement": { "required": [ "actionTypes", "agreementRevisionId", "interactionState", "version" ], "type": "object", "properties": { "agreementRevisionId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "Agreement revision UUID" }, "interactionState": { "type": "string", "description": "Agreement interaction state", "enum": [ "AVAILABLE", "ACCEPTED" ] }, "version": { "maxLength": 20, "minLength": 0, "type": "string", "description": "Agreement version" }, "lastConsentVersion": { "maxLength": 20, "minLength": 0, "type": "string", "description": "The latest version agreement is consented" }, "lastConsentDatetime": { "type": "string", "description": "Agreement last consent date", "format": "date-time", "example": "2016-03-28T12:26:21-04:00" }, "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Agreement unique code" }, "title": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Agreement title" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Agreement description" }, "mediaList": { "type": "array", "description": "Agreement media list", "items": { "$ref": "#/components/schemas/PartnerAgreementService_AgreementMedia" } }, "actionTypes": { "type": "array", "description": "Agreement action types", "items": { "$ref": "#/components/schemas/PartnerAgreementService_AgreementActionType" } } }, "description": "Partner agreement resource representation.", "xml": { "name": "partnerAgreement" } }, "PartnerAgreementService_PartnerAgreementListResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerAgreements": { "type": "array", "description": "List of partner agreements", "xml": { "name": "partnerAgreementList", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerAgreementService_PartnerAgreement" } } }, "xml": { "name": "partnerAgreementListResponse" } }, "service-offer-code": { "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" } }, "PartnerAgreementService_CreateAgreementInteractionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "agreementInteractionId": { "type": "string", "description": "Agreement interaction id" } }, "xml": { "name": "createAgreementInteractionResponse" } }, "PartnerAgreementService_PartnerAgreementInteractRequest": { "required": [ "createAgreementInteraction" ], "type": "object", "properties": { "createAgreementInteraction": { "$ref": "#/components/schemas/CreateAgreementInteraction" } }, "xml": { "name": "partnerAgreementInteractRequest" } }, "PartnerAssociateService_CreatePartnerAssociateResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerAssociateId": { "type": "string", "description": "The partner associate's unique universal partner id" } }, "xml": { "name": "createPartnerAssociateResponse" } }, "PartnerAssociateService_CreatePartnerAssociate": { "required": [ "email", "firstName", "lastName", "partnerAssociateType" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's first name.", "example": "Susan" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's last name.", "example": "Smith" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An associate's email.", "example": "susan.smith@gmail.com" }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The associate's title.", "example": "VP of Buying" }, "phone": { "$ref": "#/components/schemas/PartnerAssociateService_Phone" }, "partnerAssociateType": { "type": "string", "description": "Partner associate type", "example": "ASSOCIATE", "enum": [ "PRIMARY_ACCOUNT_MANAGER", "ASSOCIATE" ] } }, "description": "The partner associate information to update", "xml": { "name": "postPartnerAssociate" } }, "PartnerAssociateService_CreatePartnerAssociateRequest": { "required": [ "createPartnerAssociate" ], "type": "object", "properties": { "createPartnerAssociate": { "$ref": "#/components/schemas/PartnerAssociateService_CreatePartnerAssociate" } }, "xml": { "name": "createSubPartnerRequest" } }, "PartnerAssociateService_Phone": { "type": "object", "properties": { "countryCode": { "pattern": "^[0-9]{0,3}", "type": "string", "description": "Country code", "example": "1" }, "subscriberNumber": { "pattern": "^[0-9]{0,12}", "type": "string", "description": "The associate's phone number.", "example": "6155841898" }, "extension": { "pattern": "^[0-9]{0,5}", "type": "string", "description": "Optional phone extension", "example": "6155" } }, "description": "The associate's phone number.", "xml": { "name": "phone" } }, "PartnerAssociateService_GetPartnerAssociatesResponse": { "required": [ "partnerAssociates" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerAssociates": { "type": "array", "description": "A list of partner associates", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerAssociateService_PartnerAssociate" } } }, "xml": { "name": "getPartnerAssociatesResponse" } }, "PartnerAssociateService_PartnerAssociate": { "required": [ "email", "firstName", "lastName", "partnerAssociateId", "partnerAssociateType", "userProfileId" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's first name.", "example": "Susan" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's last name.", "example": "Smith" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An associate's email.", "example": "susan.smith@gmail.com" }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The associate's title.", "example": "VP of Buying" }, "phone": { "$ref": "#/components/schemas/PartnerAssociateService_Phone" }, "partnerAssociateType": { "type": "string", "description": "Partner associate type", "example": "ASSOCIATE", "enum": [ "PRIMARY_ACCOUNT_MANAGER", "ASSOCIATE" ] }, "partnerAssociateId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner associate's unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "userProfileId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The user profile's unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312", "xml": { "name": "userProfileUuid" } }, "userAccountExists": { "type": "boolean", "description": "Does user account exist for this associate?" }, "pendingInvitationExists": { "type": "boolean", "description": "Any pending invitation exists for this associate?" }, "platformEmployeeUserAccountExists": { "type": "boolean", "description": "Does the user account also have a platform employee user account?" }, "invitationStatus": { "type": "string", "description": "Associate Invitation Status Code" } }, "description": "The partner associate", "xml": { "name": "partnerAssociate" } }, "PartnerAssociateService_UpdatePartnerAssociateResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updatePartnerAssociateResponse" } }, "PartnerAssociateService_UpdatePartnerAssociateRequest": { "required": [ "updatePartnerAssociate" ], "type": "object", "properties": { "updatePartnerAssociate": { "$ref": "#/components/schemas/PartnerAssociateService_CreatePartnerAssociate" } }, "xml": { "name": "updatePartnerAssociateRequest" } }, "PartnerAssociateService_DeletePartnerAssociateResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "DeletePartnerAssociateResponse" } }, "PartnerAssociateService_GetPartnerAssociateResponse": { "required": [ "partnerAssociate" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerAssociate": { "$ref": "#/components/schemas/PartnerAssociateService_PartnerAssociate" } }, "xml": { "name": "partnerAssociateResponse" } }, "PartnerAssociateInviteService_CancelPartnerAssociateInvitesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "cancelPartnerAssociateInvitesResponse" } }, "PartnerAssociateInviteService_InvitePartnerAssociateResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "invitePartnerAssociateResponse" } }, "PartnerAssociatePermissionService_AssociatePermission": { "required": [ "compositeOperation", "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the associate permission. Use this identifier when assigning a permission to an associate.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "assignment": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_AssociatePermissionAssignment" }, "compositeOperation": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_CompositeOperation" } }, "description": "In the context of a permission feature, this resource is used to describe further information about the 'verb' of the feature as well as other metadata.", "xml": { "name": "associatePermission" } }, "PartnerAssociatePermissionService_AssociatePermissionAssignment": { "required": [ "date", "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the associate permission assignment. Use this identifier when managing a permission assignment for an associate.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "date": { "type": "string", "description": "The date the permission was assigned to the associate.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "A resource that indicates metadata about a permission that has been assigned to an associate.", "xml": { "name": "associatePermissionAssignment" } }, "PartnerAssociatePermissionService_AssociatePermissionFeature": { "required": [ "code", "description", "displayOrder", "name", "permissions" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the permission's feature.", "example": "PC_PRODUCT_LISTINGS" }, "name": { "type": "string", "description": "The short name for the permission's feature.", "example": "Product Listings" }, "description": { "type": "string", "description": "A description of the permission's feature.", "example": "This feature allows the user to manage Product Listings Information." }, "displayOrder": { "type": "integer", "description": "The order that the associate permission features should be displayed", "format": "int32", "example": 3 }, "permissions": { "type": "array", "description": "The permissions associated with this feature.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_AssociatePermission" } } }, "description": "A feature describes the target or the 'what' part that a permission applies to.", "xml": { "name": "associatePermissionFeature" } }, "PartnerAssociatePermissionService_CompositeOperation": { "required": [ "description", "displayOrder", "name", "operations" ], "type": "object", "properties": { "name": { "type": "string", "description": "The short name for the composite operation's code.", "example": "View & Edit" }, "description": { "type": "string", "description": "The description of the composite operation's code.", "example": "The View & Edit composite operation allows a user to read, create, or update an entity." }, "displayOrder": { "type": "integer", "description": "The order that the composite operations should be displayed", "format": "int32", "example": 3 }, "operations": { "type": "array", "description": "The set of granular operations represented by the composite operation.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_GranularOperation" } } }, "description": "The compound 'verb' of the permission features. Combines many granular verbs, like 'View' and 'Edit'", "xml": { "name": "compositeOperation" } }, "PartnerAssociatePermissionService_GetPartnerAssociatePermissionResponse": { "required": [ "categories" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "categories": { "type": "array", "description": "The set of categorized associate permission features.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_associatePermissionFeatureCategory" } } }, "xml": { "name": "getPartnerAssociatePermissionResponse" } }, "PartnerAssociatePermissionService_GranularOperation": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unqiue code representing the granular operation.", "example": "READ" }, "name": { "type": "string", "description": "The short name for the granular operation's code.", "example": "Read" }, "description": { "type": "string", "description": "The description of the granular operation's code.", "example": "Allows the user to perform a read operation on an entity." }, "displayOrder": { "type": "integer", "description": "The order that the granular operation should be displayed", "format": "int32", "example": 3 } }, "description": "The 'verb' of the permission feature. For example, 'View'.", "xml": { "name": "granularOperation" } }, "PartnerAssociatePermissionService_associatePermissionFeatureCategory": { "required": [ "code", "description", "displayOrder", "features", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unqiue code representing the permission's feature.", "example": "LISTINGS" }, "name": { "type": "string", "description": "The short name for the permission's feature.", "example": "Listings" }, "description": { "type": "string", "description": "A description of the permission's feature.", "example": "The Listings feature category includes features related to managing product information." }, "displayOrder": { "type": "integer", "description": "The order that the associate permission feature categories should be displayed", "format": "int32", "example": 3 }, "features": { "type": "array", "description": "The features associated with this permissions category.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_AssociatePermissionFeature" } } }, "description": "Category for an associate system feature used to group features that are alike or belong together logically.", "xml": { "name": "associatePermissionFeatureCategory" } }, "PartnerAssociatePermissionService_CreateAssociatePermissionAssignment": { "required": [ "date", "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the associate permission assignment. Use this identifier when managing a permission assignment for an associate.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "date": { "type": "string", "description": "The date the permission was assigned to the associate.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "A resource that indicates metadata about a permission that has been assigned to an associate.", "xml": { "name": "CreateAssociatePermissionAssignment" } }, "PartnerAssociatePermissionService_CreatePartnerAssociatePermissionAssignmentResponse": { "required": [ "createAssociatePermissionAssignment" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "createAssociatePermissionAssignment": { "$ref": "#/components/schemas/PartnerAssociatePermissionService_CreateAssociatePermissionAssignment" } }, "xml": { "name": "createPartnerAssociatePermissionAssignmentResponse" } }, "PartnerAssociatePermissionService_CreatePartnerAssociatePermissionAssignmentRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the associate permission.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerAssociatePermissionAssignmentRequest" } }, "PartnerAssociatePermissionService_DeletePartnerAssociatePermissionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerAssociatePermissionResponse" } }, "PartnerBulkImportService_CreateBulkImportHeaderResponse": { "required": [ "bulkImportId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "bulkImportId": { "type": "string", "description": "The import uuid for the partner.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createBulkImportHeaderResponse" } }, "PartnerBulkImportService_CreateBulkImportHeaderRequest": { "required": [ "importTypeCode" ], "type": "object", "properties": { "importTypeCode": { "type": "string", "description": "The code for import type " }, "importConfiguration": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportConfiguration" } }, "xml": { "name": "createBulkImportHeaderRequest" } }, "PartnerBulkImportService_ImportConfiguration": { "type": "object", "properties": { "productOptionCode": { "type": "string", "description": "The product option code " }, "inventoryApplyMethodCode": { "type": "string", "description": "The inventory apply method code " }, "listingMediaMapMethodCode": { "type": "string", "description": "The listing media map method code " }, "positionDelimiterCharacterCode": { "type": "string", "description": "The position delimiter character code " }, "listingMediaConflictActionOptionCode": { "type": "string", "description": "The listing media conflict action option code " } }, "description": "The import configuration to import ", "xml": { "name": "importConfiguration" } }, "PartnerBulkImportService_CreateBulkImportAssetUploadUriResponse": { "required": [ "apiKey", "folder", "signature", "timeStamp", "uploadPreset" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "signature": { "type": "string", "description": "The signature corresponding to the passed in asset upload URI parameters." }, "timeStamp": { "type": "integer", "description": "The time stamp corresponding to when the asset upload URI parameters were signed.", "format": "int64" }, "folder": { "type": "string", "description": "The folder name where the asset should be uploaded." }, "apiKey": { "type": "string", "description": "The api key used for signature signing." }, "uploadPreset": { "type": "string", "description": "The upload preset used for signature signing." } }, "xml": { "name": "createBulkImportAssetUploadUriResponse" } }, "PartnerBulkImportService_CreateBulkImportAssetUploadUriRequest": { "required": [ "source" ], "type": "object", "properties": { "source": { "type": "string", "description": "Describes the asset upload source", "example": "uw" }, "filenameOverride": { "type": "string", "description": "Describes the filename override used by some Cloudinary widget integrations", "example": "IMG103034.png" }, "headers": { "type": "string", "description": "Describes headers used by some Cloudinary widget integrations", "example": "Dropbox-API-Arg: {\"path\":\"/img_2195.jpg\"} " } }, "xml": { "name": "createBulkImportAssetUploadUriRequest" } }, "PartnerBulkImportService_GetListOfBulkImportHeadersResponse": { "required": [ "filteredListCount", "importHeaders", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "filteredListCount": { "type": "integer", "description": "Total Count of Import Headers matching Query Parameters.", "format": "int32" }, "totalListCount": { "type": "integer", "description": "Total Count of Import Headers.", "format": "int32" }, "importHeaders": { "type": "array", "description": "The set of Import Headers.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportHeader" } } }, "xml": { "name": "getListOfBulkImportHeadersResponse" } }, "PartnerBulkImportService_Get_ImportConfiguration": { "required": [ "inventoryApplyMethod", "listingMediaConflictActionOption", "listingMediaMappingMethod", "positionDelimiterCharacter", "productOption" ], "type": "object", "properties": { "productOption": { "$ref": "#/components/schemas/PartnerCommonService_ProductOptions" }, "inventoryApplyMethod": { "$ref": "#/components/schemas/PartnerCommonService_InventoryApplyMethods" }, "listingMediaMappingMethod": { "$ref": "#/components/schemas/PartnerCommonService_ListingMediaMappingMethod" }, "listingMediaConflictActionOption": { "$ref": "#/components/schemas/PartnerCommonService_ListingMediaMappingMethod" }, "positionDelimiterCharacter": { "$ref": "#/components/schemas/PartnerCommonService_PositionDelimiterCharacter" } }, "description": "The import configuration", "xml": { "name": "importConfiguration" } }, "PartnerBulkImportService_ImportHeader": { "required": [ "createDateTime", "importConfiguration", "importHeaderId", "importHeaderNumber", "importHeaderStatus", "importHeaderType", "importLineCount", "importName" ], "type": "object", "properties": { "importHeaderId": { "type": "string", "description": "The import header id" }, "importHeaderNumber": { "type": "string", "description": "The import header number" }, "importHeaderStatus": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportHeaderStatus" }, "importHeaderType": { "$ref": "#/components/schemas/PartnerCommonService_ImportHeaderType" }, "importConfiguration": { "$ref": "#/components/schemas/PartnerBulkImportService_Get_ImportConfiguration" }, "filenames": { "type": "array", "description": "The set of Bulk Import files name.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The set of Bulk Import files name.", "xml": { "name": "filename" } } }, "errorFileLocation": { "type": "string", "description": "Location of error file if import header was processed with errors" }, "createDateTime": { "type": "string", "description": "The create date and time of header", "format": "date-time" }, "importName": { "type": "string", "description": "The bulk import name" }, "importLineCount": { "type": "integer", "description": "The import line count of header", "format": "int32" }, "importLineProcessedCount": { "type": "integer", "description": "The import line processor count of header", "format": "int32" }, "importLineSucceededCount": { "type": "integer", "description": "The import line succeeded count of header", "format": "int32" }, "importLineFailedCount": { "type": "integer", "description": "The import line failed count of header", "format": "int32" }, "importLineNotChangedCount": { "type": "integer", "description": "The import line not changed count of header", "format": "int32" } }, "description": "The set of Import Headers.", "xml": { "name": "importHeader" } }, "PartnerBulkImportService_ImportHeaderStatus": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for import header status", "example": "PENDING_DATA" }, "name": { "type": "string", "description": "name for import header status", "example": "Pending Data" }, "description": { "type": "string", "description": "description for import header status", "example": "The import has been created and is awaiting the upload of data." }, "displayOrder": { "type": "integer", "description": "display order for import header type", "format": "int64", "example": 10 } }, "description": "The set of Import Header Status.", "xml": { "name": "importHeaderStatus" } }, "PartnerCommonService_ImportHeaderType": { "required": [ "code", "description", "displayOrder", "inventoryApplyMethods", "listingMediaConflictActionOptions", "listingMediaDelimiterCharacters", "listingMediaMappingMethods", "name", "productOptions" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for import header type", "example": "LISTING_MEDIA" }, "name": { "type": "string", "description": "name for import header type", "example": "Listing Media" }, "description": { "type": "string", "description": "description for import header type", "example": "Bottom" }, "displayOrder": { "type": "integer", "description": "display order for import header type", "format": "int64", "example": 10 }, "productOptions": { "type": "array", "description": "The class of product options", "items": { "$ref": "#/components/schemas/PartnerCommonService_ProductOptions" } }, "inventoryApplyMethods": { "type": "array", "description": "The class of inventory apply methods", "items": { "$ref": "#/components/schemas/PartnerCommonService_InventoryApplyMethods" } }, "listingMediaMappingMethods": { "type": "array", "description": "The class of listing media mapping methods", "items": { "$ref": "#/components/schemas/PartnerCommonService_ListingMediaMappingMethods" } }, "listingMediaDelimiterCharacters": { "type": "array", "description": "The class of listing media delimiter characters", "items": { "$ref": "#/components/schemas/PartnerCommonService_ListingMediaDelimiterCharacters" } }, "listingMediaConflictActionOptions": { "type": "array", "description": "The class of listing media conflict action options", "items": { "$ref": "#/components/schemas/PartnerCommonService_ListingMediaConflictActionOption" } } }, "description": "The set of Import Header Types.", "xml": { "name": "importHeaderType" } }, "PartnerCommonService_InventoryApplyMethods": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for inventory apply method", "example": "APPLY_TO_DS_ON_HAND" }, "name": { "type": "string", "description": "name for inventory apply method", "example": "Apply to On Hand Quantity" }, "description": { "type": "string", "description": "description for inventory apply method", "example": "Apply directly to on hand quantity." }, "displayOrder": { "type": "integer", "description": "display order for inventory apply method", "format": "int64", "example": 10 } }, "description": "The class of inventory apply methods", "xml": { "name": "inventoryApplyMethods" } }, "PartnerCommonService_ListingMediaMappingMethod": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for listing media conflict action option", "example": "FAIL" }, "name": { "type": "string", "description": "name for listing media conflict action option", "example": "Fail" }, "description": { "type": "string", "description": "description for listing media conflict action option", "example": "The Bulk Import processor shall Fail the line, resulting in a Failed line status due to the conflicting media item." } }, "description": "The listing media conflict action option", "xml": { "name": "listingMediaMappingMethod" } }, "PartnerCommonService_PositionDelimiterCharacter": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for listing media delimiter character", "example": "NO_DELIMITER" }, "name": { "type": "string", "description": "name for listing media delimiter character", "example": "No Delimiter" }, "description": { "type": "string", "description": "description for listing media delimiter character", "example": "No delimiter exists within the filename." } }, "description": "The position delimiter character", "xml": { "name": "positionDelimiterCharacter" } }, "PartnerCommonService_ProductOptions": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for inventory apply method", "example": "SUPPLIER_STYLE_NUMBER" }, "name": { "type": "string", "description": "name for inventory apply method", "example": "Supplier Style Number (Style #)" }, "description": { "type": "string", "description": "description for inventory apply method", "example": "Supplier Style Number" }, "displayOrder": { "type": "integer", "description": "display order for inventory apply method", "format": "int64", "example": 10 } }, "description": "The class of product options", "xml": { "name": "productOptions" } }, "PartnerBulkImportService_GetBulkImportHeaderDetailResponse": { "required": [ "importHeaderDetail" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "importHeaderDetail": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportHeaderDetail" } }, "xml": { "name": "getBulkImportHeaderDetailResponse" } }, "PartnerBulkImportService_Get_ImportHeaderCreateInfo": { "required": [ "dateTime", "firstName", "lastName", "userAccountId", "userName" ], "type": "object", "properties": { "dateTime": { "type": "string", "description": "Date time info for import header", "format": "date-time" }, "userAccountId": { "type": "integer", "description": "User account id associated with import header", "format": "int64" }, "firstName": { "type": "string", "description": "User first name associated with import header" }, "lastName": { "type": "string", "description": "User last name associated with import header" }, "userName": { "type": "string", "description": "User first name associated with import header" } }, "description": "The created info for import header", "xml": { "name": "importHeaderCreateInfo" } }, "PartnerBulkImportService_Get_ImportHeaderInfo": { "type": "object", "properties": { "dateTime": { "type": "string", "description": "Date time info for import header", "format": "date-time" }, "userAccountId": { "type": "integer", "description": "User account id associated with import header", "format": "int64" }, "firstName": { "type": "string", "description": "User first name associated with import header" }, "lastName": { "type": "string", "description": "User last name associated with import header" }, "userName": { "type": "string", "description": "User first name associated with import header" } }, "description": "The updated info for import header", "xml": { "name": "importHeaderInfo" } }, "PartnerBulkImportService_ImportHeaderDetail": { "required": [ "createDateTime", "importConfiguration", "importHeaderId", "importHeaderNumber", "importHeaderStatus", "importHeaderType", "importLineCount", "importName" ], "type": "object", "properties": { "importHeaderId": { "type": "string", "description": "The import header id" }, "importHeaderNumber": { "type": "string", "description": "The import header number" }, "importHeaderStatus": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportHeaderStatus" }, "importHeaderType": { "$ref": "#/components/schemas/PartnerCommonService_ImportHeaderType" }, "importConfiguration": { "$ref": "#/components/schemas/PartnerBulkImportService_Get_ImportConfiguration" }, "filenames": { "type": "array", "description": "The set of Bulk Import files name.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The set of Bulk Import files name.", "xml": { "name": "filename" } } }, "errorFileLocation": { "type": "string", "description": "Location of error file if import header was processed with errors" }, "createDateTime": { "type": "string", "description": "The create date and time of header", "format": "date-time" }, "importName": { "type": "string", "description": "The bulk import name" }, "importLineCount": { "type": "integer", "description": "The import line count of header", "format": "int32" }, "importLineProcessedCount": { "type": "integer", "description": "The import line processor count of header", "format": "int32" }, "importLineSucceededCount": { "type": "integer", "description": "The import line succeeded count of header", "format": "int32" }, "importLineFailedCount": { "type": "integer", "description": "The import line failed count of header", "format": "int32" }, "importLineNotChangedCount": { "type": "integer", "description": "The import line not changed count of header", "format": "int32" }, "createInformation": { "$ref": "#/components/schemas/PartnerBulkImportService_Get_ImportHeaderCreateInfo" }, "updateInformation": { "$ref": "#/components/schemas/PartnerBulkImportService_Get_ImportHeaderInfo" } }, "description": "The import header detail", "xml": { "name": "importHeaderDetail" } }, "PartnerBulkImportService_UpdateBulkImportHeaderResponse": { "required": [ "bulkImportId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "bulkImportId": { "type": "string", "description": "The import uuid for the partner.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "updateBulkImportHeaderResponse" } }, "PartnerBulkImportService_UpdateBulkImportHeaderRequest": { "required": [ "importHeaderStatusCode", "importTypeCode" ], "type": "object", "properties": { "importTypeCode": { "type": "string", "description": "The code for import type " }, "importConfiguration": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportConfiguration" }, "importHeaderStatusCode": { "type": "string", "description": "The import header status code " }, "importName": { "type": "string", "description": "The bulk import name" } }, "xml": { "name": "updateBulkImportHeaderRequest" } }, "PartnerBulkImportService_CancelBulkImportHeaderResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "cancelBulkImportHeaderResponse" } }, "BulkInventoryAutoConfig": { "type": "object", "properties": { "partnerId": { "type": "integer", "format": "int32" }, "partnerUuid": { "type": "string" }, "feedPath": { "type": "string" }, "externalAuthenticationMethod": { "type": "string", "enum": [ "PUBLIC_KEY", "USERNAME_PASSWORD" ] }, "externalUserName": { "type": "string" }, "externalEmailAddress": { "type": "string" }, "externalPublicKey": { "type": "string" }, "bulkInventoryDataSourceCode": { "type": "string", "enum": [ "AMAZON_S_3", "CLOUDINARY" ] }, "importTypeCodeEnum": { "type": "string", "enum": [ "DROP_SHIP_INVENTORY", "LISTING_MEDIA", "SELLER_FULFILLED_INVENTORY", "SUPPLIER_PRICE" ] }, "inventoryApplyMethod": { "$ref": "#/components/schemas/InventoryApplyMethod" }, "importProductOption": { "$ref": "#/components/schemas/ImportProductOption" }, "configUserAccountId": { "type": "integer", "format": "int64" }, "externalEndpointURL": { "type": "string" } }, "description": "The bulk inventory auto config" }, "ImportProductOption": { "type": "object", "properties": { "importProductOptionId": { "type": "integer", "format": "int64" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int64" }, "activeFlag": { "type": "boolean" } } }, "InventoryApplyMethod": { "type": "object", "properties": { "inventoryApplyMethodId": { "type": "integer", "format": "int64" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int64" }, "activeFlag": { "type": "boolean" } } }, "PartnerBulkImportService_GetBulkInventoryAutoConfigByPartnerUuidResponse": { "required": [ "bulkInventoryAutoConfig" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "bulkInventoryAutoConfig": { "$ref": "#/components/schemas/BulkInventoryAutoConfig" } }, "xml": { "name": "getBulkInventoryAutoConfigByPartnerUuidResponse" } }, "PartnerBulkImportService_SendBulkInventoryAutoConfigResetPasswordEmailResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "sendBulkInventoryAutoConfigResetPasswordEmailResponse" } }, "PartnerBulkImportService_SaveBulkInventoryAutoConfigResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "saveBulkInventoryAutoConfigResponse" } }, "SaveBulkInventoryAutoConfigRequest": { "required": [ "bulkInventoryDataSourceCode", "externalAuthenticationMethod", "externalEmailAddress", "externalPublicKey", "externalUserName", "importProductOption", "importTypeCode", "inventoryApplyMethod" ], "type": "object", "properties": { "importTypeCode": { "type": "string", "description": "The code for import type " }, "externalAuthenticationMethod": { "type": "string", "description": "External authentication method used to access external service for bulk inventory files " }, "externalUserName": { "type": "string", "description": "External username used to access external service for bulk inventory files" }, "externalEmailAddress": { "type": "string", "description": "External email address used for email verification with the idp" }, "externalPublicKey": { "type": "string", "description": "Public key from external vendors used to access automated bulk import service " }, "bulkInventoryDataSourceCode": { "type": "string", "description": "Where the auto bulk inventory data will originate from " }, "inventoryApplyMethod": { "type": "string", "description": "Code for apply method " }, "importProductOption": { "type": "string", "description": "Code for product option " } } }, "PartnerCommonService_GetRoleResponse": { "required": [ "role" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "role": { "type": "array", "description": "The User Profile roles available.", "xml": { "name": "roles", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_Role" } } }, "xml": { "name": "getRoleResponse" } }, "PartnerCommonService_Role": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop user role", "example": "FASHION_EDITOR" }, "name": { "type": "string", "description": "name for the shop user role", "example": "Fashion Editor" }, "description": { "type": "string", "description": "description for the shop user role", "example": "Fashion Editor" }, "displayOrder": { "type": "integer", "description": "display order for the shop user role", "format": "int32", "example": 1 } }, "description": "User Profile Role", "xml": { "name": "role" } }, "PartnerCommonService_GetShopProfileLabelsResponse": { "required": [ "shopProfileLabels" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileLabels": { "type": "array", "description": "The available shop profile labels", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShopProfileLabel" } } }, "xml": { "name": "getShopProfileLabelsResponse" } }, "PartnerCommonService_ShopProfileLabel": { "required": [ "code", "description", "displayOrder", "name", "systemManaged" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop profile label", "example": "POPULAR_TODAY" }, "name": { "type": "string", "description": "name for the shop profile label", "example": "Popular Today" }, "description": { "type": "string", "description": "description for the shop profile label", "example": "Popular Today" }, "displayOrder": { "type": "integer", "description": "display order for the shop profile label", "format": "int64", "example": 1 }, "systemManaged": { "type": "boolean", "description": "is the shop profile label system managed?", "example": false } }, "description": "Shop Profile Label", "xml": { "name": "shopProfileLabel" } }, "PartnerCommonService_GetShopProfileCategoriesResponse": { "required": [ "shopProfileCategories" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileCategories": { "type": "array", "description": "The available shop profile categories", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShopProfileCategory" } } }, "xml": { "name": "getShopProfileCategoriesResponse" } }, "PartnerCommonService_ShopProfileCategory": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop profile category", "example": "FAST_FASHION" }, "name": { "type": "string", "description": "name for the shop profile category", "example": "Fast-Fashion" }, "description": { "type": "string", "description": "description for the shop profile category", "example": "Fast-Fashion" }, "displayOrder": { "type": "integer", "description": "display order for the shop profile category", "format": "int64", "example": 1 } }, "description": "Shop Profile Category", "xml": { "name": "shopProfileCategory" } }, "PartnerCommonService_GetShopProfileExternalLinkTypesResponse": { "required": [ "shopProfileExternalLinkTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileExternalLinkTypes": { "type": "array", "description": "The available shop profile external link types", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShopProfileExternalLinkType" } } }, "xml": { "name": "getShopProfileExternalLinkTypesResponse" } }, "PartnerCommonService_ShopProfileExternalLinkType": { "required": [ "code", "customType", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop profile external link type", "example": "FACEBOOK" }, "name": { "type": "string", "description": "name for the shop profile external link type", "example": "Facebook" }, "description": { "type": "string", "description": "description for the shop profile external link type", "example": "Facebook" }, "displayOrder": { "type": "integer", "description": "display order for the shop profile external link type", "format": "int32", "example": 10 }, "customType": { "type": "boolean", "description": "is the shop profile using a custom external link type", "example": true } }, "description": "Shop Profile External Link Type", "xml": { "name": "shopProfileExternalLinkType" } }, "PartnerCommonService_Carrier": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the carrier.", "example": "USPS" }, "name": { "type": "string", "description": "The name representing the carrier.", "example": "United States Postal Service (USPS)" }, "description": { "type": "string", "description": "The description for the carrier.", "example": "United States Postal Service" } }, "description": "Describes an available carrier for packages", "xml": { "name": "carrier" } }, "PartnerCommonService_GetPackagingTypesResponse": { "required": [ "packagingTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packagingTypes": { "type": "array", "description": "The permissions associated with this feature.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_PackagingType" } } }, "xml": { "name": "getPackagingTypesResponse" } }, "PartnerCommonService_PackageDimensions": { "required": [ "height", "length", "unitOfMeasure", "width" ], "type": "object", "properties": { "length": { "type": "number", "description": "The package length dimension.", "format": "double", "example": 12 }, "width": { "type": "number", "description": "The package length dimension.", "format": "double", "example": 13 }, "height": { "type": "number", "description": "The package height dimension.", "format": "double", "example": 7 }, "unitOfMeasure": { "$ref": "#/components/schemas/PartnerCommonService_UnitOfMeasure" } }, "description": "Describes the package's dimensions", "xml": { "name": "packageDimensions" } }, "PartnerCommonService_PackagingBrand": { "required": [ "carrier", "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the unit of measure.", "example": "USPS" }, "name": { "type": "string", "description": "The name representing the unit of measure.", "example": "United States Postal Service (USPS)" }, "description": { "type": "string", "description": "The description for the carrier.", "example": "United States Postal Service" }, "carrier": { "$ref": "#/components/schemas/PartnerCommonService_Carrier" } }, "description": "Describes a package brand.", "xml": { "name": "packagingBrand" } }, "PartnerCommonService_PackagingType": { "required": [ "code", "description", "displayOrder", "name", "packageDimensions", "packagingBrand" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code for the packaging type.", "example": "UPS_EXPRESS_BOX_SMALL" }, "name": { "type": "string", "description": "The name for the packaging type.", "example": "UPS Express Box - Small" }, "description": { "type": "string", "description": "The description for the packaging type.", "example": "Small Express Box" }, "displayOrder": { "type": "integer", "description": "The order to display amongst other packaging types.", "format": "int32", "example": 1 }, "packagingBrand": { "$ref": "#/components/schemas/PartnerCommonService_PackagingBrand" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerCommonService_PackageDimensions" } }, "description": "Describes packaging types", "xml": { "name": "packagingType" } }, "PartnerCommonService_UnitOfMeasure": { "required": [ "abbreviation", "baseQuantityCode", "baseQuantityName", "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the unit of measure.", "example": "INCH" }, "name": { "type": "string", "description": "The name representing the unit of measure.", "example": "inch" }, "description": { "type": "string", "description": "The description for the unit of measure.", "example": "Inch" }, "abbreviation": { "type": "string", "description": "The abbreviation representing the unit of measure.", "example": "in" }, "baseQuantityCode": { "type": "string", "description": "The base quantity code for the unit of measure.", "example": "LENGTH" }, "baseQuantityName": { "type": "string", "description": "The base quantity name for the unit of measure.", "example": "Length" } }, "description": "Describes an available metric for measurement", "xml": { "name": "unitOfMeasure" } }, "PartnerCommonService_BankTransferCountryConfig": { "required": [ "bankTransferCurrencyConfigList", "countryDisplayName", "countryIso2Code", "countryIso3Code", "countryIsoNumeric", "displayOrder" ], "type": "object", "properties": { "countryIso2Code": { "type": "string", "description": "Iso2 code of the country", "example": "US" }, "countryIso3Code": { "type": "string", "description": "Iso3 code of the country", "example": "USA" }, "countryIsoNumeric": { "type": "integer", "description": "IsoNumeric code of the country", "format": "int32", "example": 840 }, "countryDisplayName": { "type": "string", "description": "Display name of the country", "example": "United States" }, "displayOrder": { "type": "integer", "description": "The order to display among other country config", "format": "int32", "example": 5 }, "bankTransferCurrencyConfigList": { "type": "array", "description": "The available bank transfer currency configurations", "xml": { "name": "currencyTypes", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_BankTransferCurrencyConfig" } } }, "description": "Bank Transfer Country Config", "xml": { "name": "bankTransferCountryConfig" } }, "PartnerCommonService_BankTransferCurrencyConfig": { "required": [ "bankTransferTypeConfigList", "currencyTypeCode", "currencyTypeDisplayName", "currencyTypeName" ], "type": "object", "properties": { "currencyTypeCode": { "type": "string", "description": "Code of the currency", "example": "USD" }, "currencyTypeName": { "type": "string", "description": "Name of the currency", "example": "USD" }, "currencyTypeDisplayName": { "type": "string", "description": "Display name of the currency", "example": "USD" }, "bankTransferTypeConfigList": { "type": "array", "description": "The available bank transfer type configurations", "xml": { "name": "transferTypes", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_BankTransferTypeConfig" } } }, "description": "Bank Transfer Currency Config", "xml": { "name": "bankTransferCurrencyConfig" } }, "PartnerCommonService_BankTransferTypeConfig": { "required": [ "transferTypeCode", "transferTypeDisplayName", "transferTypeName" ], "type": "object", "properties": { "transferTypeCode": { "type": "string", "description": "Transfer type code", "example": "ACH" }, "transferTypeName": { "type": "string", "description": "Transfer type name", "example": "ACH" }, "transferTypeDisplayName": { "type": "string", "description": "Transfer type display name", "example": "ACH Transfer Type" } }, "description": "Bank Transfer Type Config", "xml": { "name": "bankTransferTypeConfig" } }, "PartnerCommonService_GetBankTransferCountryConfigsResponse": { "required": [ "bankTransferCountryConfigList", "totalCountryConfigs" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalCountryConfigs": { "type": "integer", "description": "Total country configs", "format": "int32", "example": 25 }, "bankTransferCountryConfigList": { "type": "array", "description": "List of Bank transfer countries configuration.", "xml": { "name": "bankTransferConfigs", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_BankTransferCountryConfig" } } }, "xml": { "name": "getBankTransferCountryConfigsResponse" } }, "PartnerCommonService_FinancialTransactionCategory": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Transaction category code", "example": "SALES" }, "name": { "type": "string", "description": "Transaction category name", "example": "Sales" }, "description": { "type": "string", "description": "Transaction category description", "example": "Sales Activity" }, "displayOrder": { "type": "integer", "description": "Transaction category display order", "format": "int64", "example": 1 } }, "description": "Partner Financial Transaction Category", "xml": { "name": "financialTransactionCategory" } }, "PartnerCommonService_FinancialTransactionSubCategory": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Transaction sub-category code", "example": "PRODUCT_SALES" }, "name": { "type": "string", "description": "Transaction sub-category name", "example": "Product Sales" }, "description": { "type": "string", "description": "Transaction sub-category description", "example": "Product Sales Activity" }, "displayOrder": { "type": "integer", "description": "transaction sub-category display order", "format": "int64", "example": 1 } }, "description": "Partner Financial Transaction Sub-Category", "xml": { "name": "financialTransactionSubCategory" } }, "PartnerCommonService_FinancialTransactionType": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Transaction type code", "example": "PRODUCT_SALE" }, "name": { "type": "string", "description": "Transaction type name", "example": "Product Sale" }, "description": { "type": "string", "description": "Transaction type description", "example": "Product Sale" }, "displayOrder": { "type": "integer", "description": "transaction type display order", "format": "int64", "example": 1 } }, "description": "Partner Financial Transaction Type", "xml": { "name": "financialTransactionType" } }, "PartnerCommonService_GetFinancialTransactionClassificationOptionsResponse": { "required": [ "financialTransactionCategoryList", "financialTransactionSubCategoryList", "financialTransactionTypeList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "financialTransactionCategoryList": { "type": "array", "description": "Financial Transaction Category List.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FinancialTransactionCategory" } }, "financialTransactionSubCategoryList": { "type": "array", "description": "Financial Transaction Sub Category List.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FinancialTransactionSubCategory" } }, "financialTransactionTypeList": { "type": "array", "description": "Financial Transaction Type List.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FinancialTransactionType" } } }, "xml": { "name": "getFinancialTransactionClassificationOptionsResponse" } }, "PartnerCommonService_UpdatePackageStateResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updatePackageStateResponse" } }, "PartnerCommonService_PackageState": { "required": [ "packageNumber", "partnerPackageStatusCode" ], "type": "object", "properties": { "packageNumber": { "type": "string", "description": "Package Number", "example": "PS2K6K5MSXZY-000" }, "partnerPackageStatusCode": { "pattern": "^DELIVERED|SHIPPED$", "type": "string", "description": "Partner Package Status Code", "example": "DELIVERED", "enum": [ "DELIVERED", "SHIPPED" ] } }, "description": "A Package State to Update", "xml": { "name": "packageState" } }, "PartnerCommonService_UpdatePackageStateRequest": { "required": [ "updatePackageStates" ], "type": "object", "properties": { "updatePackageStates": { "type": "array", "description": "The package states for update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_PackageState" } } }, "xml": { "name": "updatePackageStateRequest" } }, "PartnerCommonService_GetShopProfileReturnPeriodResponse": { "required": [ "shopProfileReturnPeriod" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileReturnPeriod": { "type": "array", "description": "The Shop Profile Policy Return Period options available.", "xml": { "name": "shopProfileReturnPeriods", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShopProfilePolicyReturnPeriod" } } }, "xml": { "name": "getShopProfileReturnPeriodResponse" } }, "PartnerCommonService_ShopProfilePolicyReturnPeriod": { "required": [ "code", "description", "displayOrder", "name", "periodInDays" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop policy return period", "example": "45_DAYS" }, "name": { "type": "string", "description": "name for the shop profile policy return period", "example": "45 Days" }, "description": { "type": "string", "description": "description for the shop profile policy return period", "example": "Returns are accepted within 45 Days of Delivery." }, "displayOrder": { "type": "integer", "description": "display order for the shop profile policy return period", "format": "int32", "example": 1 }, "periodInDays": { "type": "integer", "description": "number of days for the shop profile policy return period", "format": "int32", "example": 45 } }, "description": "Shop Profile Policy Return Period", "xml": { "name": "shopProfilePolicyReturnPeriod" } }, "PartnerCommonService_GetUserProfileExternalLinkTypesResponse": { "required": [ "userProfileExternalLinkTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "userProfileExternalLinkTypes": { "type": "array", "description": "The available user profile external link types", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_UserProfileExternalLinkType" } } }, "xml": { "name": "getUserProfileExternalLinkTypesResponse" } }, "PartnerCommonService_UserProfileExternalLinkType": { "required": [ "code", "customType", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the user profile external link type", "example": "FACEBOOK" }, "name": { "type": "string", "description": "name for the user profile external link type", "example": "Facebook" }, "description": { "type": "string", "description": "description for the user profile external link type", "example": "Facebook" }, "displayOrder": { "type": "integer", "description": "display order for the user profile external link type", "format": "int32", "example": 10 }, "customType": { "type": "boolean", "description": "is the user profile using a custom external link type", "example": true } }, "description": "User Profile External Link Type", "xml": { "name": "userProfileExternalLinkType" } }, "PartnerCommonService_CreateHyperwalletWebhookNotificationResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "createHyperwalletWebhookNotificationResponse" } }, "PartnerCommonService_CreateHyperwalletWebhookNotificationRequest": { "required": [ "createdOn", "notificationJsonObject", "token", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The hyperwallet webhook notification type", "example": "https://docs.hyperwallet.com/content/webhooks/v1/notification-types/users" }, "token": { "type": "string", "description": "The hyperwallet webhook notification token", "example": "wbh-9e350bf5-854e-4326-9400-611a5c17d8b9" }, "notificationJsonObject": { "type": "string", "description": "The hyperwallet webhook notification object", "example": "https://docs.hyperwallet.com/content/webhooks/v1/notification-object", "xml": { "name": "object" } }, "createdOn": { "type": "string", "description": "The hyperwallet webhook created on date", "example": "2019-09-13T12:49:43" } }, "xml": { "name": "createHyperwalletWebhookNotificationRequest" } }, "PartnerCommonService_FulfillmentDeliveryServiceOrderStatus": { "required": [ "code", "description", "displayOrder", "name", "statusClass" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code for the order status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The name for the order status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description for the order status.", "example": "The order header is pending completion." }, "displayOrder": { "type": "integer", "description": "The order to display amongst other order status.", "format": "int32", "example": 1 }, "statusClass": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentDeliveryServiceOrderStatusClass" } }, "description": "Describes a drop shipment's delivery order status", "xml": { "name": "fulfillmentDeliveryServiceOrderStatus" } }, "PartnerCommonService_FulfillmentDeliveryServiceOrderStatusClass": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code for the order status class.", "example": "COMPLETE" }, "name": { "type": "string", "description": "The name for the order status class.", "example": "Complete" }, "description": { "type": "string", "description": "The description for the order status class.", "example": "The delivery service order is complete." }, "displayOrder": { "type": "integer", "description": "The order to display amongst other order status class.", "format": "int32", "example": 1 } }, "description": "Describes a drop shipment's delivery order status class", "xml": { "name": "fulfillmentDeliveryServiceOrderStatusClass" } }, "PartnerCommonService_GetFulfillmentDeliveryServiceOrderStatusResponse": { "required": [ "orderStatuses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderStatuses": { "type": "array", "description": "The list of drop ship order statuses.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentDeliveryServiceOrderStatus" } } }, "xml": { "name": "getFulfillmentDeliveryServiceOrderStatusResponse" } }, "PartnerCommonService_GetFulfillmentDeliveryServiceOrderStatusClassResponse": { "required": [ "orderStatusClasses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderStatusClasses": { "type": "array", "description": "The list of drop ship order status classes.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentDeliveryServiceOrderStatusClass" } } }, "xml": { "name": "getFulfillmentDeliveryServiceOrderStatusClassResponse" } }, "PartnerCommonService_FulfillmentDeliveryServiceOrderLineStatus": { "required": [ "code", "description", "displayOrder", "name", "statusClass" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code for the order line status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The name for the order line status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description for the order line status.", "example": "The order header is pending completion." }, "displayOrder": { "type": "integer", "description": "The order to display amongst other order line status.", "format": "int32", "example": 1 }, "statusClass": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentDeliveryServiceOrderLineStatusClass" } }, "description": "Describes a drop shipment's delivery order line status", "xml": { "name": "fulfillmentDeliveryServiceOrderLineStatus" } }, "PartnerCommonService_FulfillmentDeliveryServiceOrderLineStatusClass": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code for the order line status class.", "example": "COMPLETE" }, "name": { "type": "string", "description": "The name for the order line status class.", "example": "Complete" }, "description": { "type": "string", "description": "The description for the order line status class.", "example": "The delivery service order is complete." }, "displayOrder": { "type": "integer", "description": "The order to display amongst other order line status class.", "format": "int32", "example": 1 } }, "description": "Describes a drop shipment's delivery order line status class", "xml": { "name": "fulfillmentDeliveryServiceOrderLineStatusClass" } }, "PartnerCommonService_GetFulfillmentDeliveryServiceOrderLineStatusResponse": { "required": [ "orderLineStatuses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderLineStatuses": { "type": "array", "description": "The list of drop ship order line statuses.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentDeliveryServiceOrderLineStatus" } } }, "xml": { "name": "getFulfillmentDeliveryServiceOrderLineStatusResponse" } }, "PartnerCommonService_GetFulfillmentDeliveryServiceOrderLineStatusClassResponse": { "required": [ "orderLineStatusClasses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderLineStatusClasses": { "type": "array", "description": "The list of drop ship order line status classes.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentDeliveryServiceOrderLineStatusClass" } } }, "xml": { "name": "getFulfillmentDeliveryServiceOrderLineStatusClassResponse" } }, "PartnerCommonService_GetOrderCancelReasonListResponse": { "required": [ "orderCancelReasonGroupList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderCancelReasonGroupList": { "type": "array", "description": "List of order cancel reasons.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_OrderCancelReasonGroup" } } }, "xml": { "name": "getOrderCancelReasonListResponse" } }, "PartnerCommonService_OrderCancelReason": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Order Cancel Reason Code", "example": "CGR1" }, "name": { "type": "string", "description": "Order Cancel Reason Name", "example": "Cancel Reason One" }, "description": { "type": "string", "description": "Order Cancel Reason Description", "example": "This is just a sample cancel reason." }, "displayOrder": { "type": "integer", "description": "Order Cancel Reason Display Order", "format": "int32", "example": 1 } }, "description": "Cancel order reason", "xml": { "name": "orderCancelReason" } }, "PartnerCommonService_OrderCancelReasonGroup": { "required": [ "cancelReasons", "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Order Cancel Reason Group Code", "example": "CGR1" }, "name": { "type": "string", "description": "Order Cancel Reason Group NAME", "example": "Cancel Reason Group One" }, "description": { "type": "string", "description": "Order Cancel Reason Group Description", "example": "This is just a sample cancel reason group" }, "displayOrder": { "type": "integer", "description": "Order Cancel Reason Group Display Order", "format": "int32", "example": 1 }, "cancelReasons": { "type": "array", "description": "The cancel order reasons for this group.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_OrderCancelReason" } } }, "description": "Cancel order reason", "xml": { "name": "orderCancelReasonGroup" } }, "PartnerCommonService_GetFulfillmentShipmentGroupHeaderStatusListResponse": { "required": [ "shipmentGroupHeaderStatusList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentGroupHeaderStatusList": { "type": "array", "description": "List of shipment group header statuses.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShipmentGroupHeaderStatus" } } }, "xml": { "name": "getFulfillmentShipmentGroupHeaderStatusListResponse" } }, "PartnerCommonService_ShipmentGroupHeaderStatus": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Shipment group header status code", "example": "SGR1" }, "name": { "type": "string", "description": "Shipment group header status name", "example": "Shipment Group Header Status One" }, "description": { "type": "string", "description": "Shipment group header status description", "example": "This is just a sample shipment group header status" }, "displayOrder": { "type": "integer", "description": "Shipment group header status display order", "format": "int32", "example": 1 } }, "description": "Shipment group header status", "xml": { "name": "shipmentGroupHeaderStatus" } }, "PartnerCommonService_GetFulfillmentShipmentBatchHeaderStatusListResponse": { "required": [ "shipmentBatchHeaderStatusList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentBatchHeaderStatusList": { "type": "array", "description": "List of shipment batch header statuses.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShipmentBatchHeaderStatus" } } }, "xml": { "name": "getFulfillmentShipmentBatchHeaderStatusListResponse" } }, "PartnerCommonService_ShipmentBatchHeaderStatus": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Shipment batch header status code", "example": "SGR1" }, "name": { "type": "string", "description": "Shipment batch header status name", "example": "Shipment Batch Header Status One" }, "description": { "type": "string", "description": "Shipment batch header status description", "example": "This is just a sample shipment batch header status" }, "displayOrder": { "type": "integer", "description": "Shipment batch header status display order", "format": "int32", "example": 1 } }, "description": "Shipment batch header status", "xml": { "name": "shipmentBatchHeaderStatus" } }, "PartnerCommonService_GetFulfillmentShipmentBatchHeaderStatusClassificationListResponse": { "required": [ "shipmentBatchHeaderStatusClassificationList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentBatchHeaderStatusClassificationList": { "type": "array", "description": "List of shipment batch header status classifications.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShipmentBatchHeaderStatusClassification" } } }, "xml": { "name": "getFulfillmentShipmentBatchHeaderStatusClassificationListResponse" } }, "PartnerCommonService_ShipmentBatchHeaderStatusClassification": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Shipment batch header status classification code", "example": "SGR1" }, "name": { "type": "string", "description": "Shipment batch header status classification name", "example": "Shipment Batch Header Status Classification One" }, "description": { "type": "string", "description": "Shipment batch header status classification description", "example": "This is just a sample shipment batch header status classification" }, "displayOrder": { "type": "integer", "description": "Shipment batch header status classification display order", "format": "int32", "example": 1 } }, "description": "Shipment batch header status classification", "xml": { "name": "shipmentBatchHeaderStatusClassification" } }, "PartnerCommonService_GetFulfillmentShipmentGroupHeaderStatusClassificationListResponse": { "required": [ "shipmentGroupHeaderStatusClassificationList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentGroupHeaderStatusClassificationList": { "type": "array", "description": "List of shipment group header status classifications.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ShipmentGroupHeaderStatusClassification" } } }, "xml": { "name": "getFulfillmentShipmentGroupHeaderStatusClassificationListResponse" } }, "PartnerCommonService_ShipmentGroupHeaderStatusClassification": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Shipment group header status classification code", "example": "SGR1" }, "name": { "type": "string", "description": "Shipment group header status classification name", "example": "Shipment Group Header Status Classification One" }, "description": { "type": "string", "description": "Shipment group header status classification description", "example": "This is just a sample shipment group header status classification" }, "displayOrder": { "type": "integer", "description": "Shipment group header status classification display order", "format": "int32", "example": 1 } }, "description": "Shipment group header status classification", "xml": { "name": "shipmentGroupHeaderStatusClassification" } }, "PartnerCommonService_GetMediaContentMediaSubjectResponse": { "required": [ "mediaContentMediaSubjects" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "mediaContentMediaSubjects": { "type": "array", "description": "The Media Content Media Subjects available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_MediaContentMediaSubject" } } }, "xml": { "name": "getMediaContentMediaSubjectResponse" } }, "PartnerCommonService_MediaContentMediaSubject": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the media subject", "example": "GROUP_PRODUCT" }, "name": { "type": "string", "description": "name for the media subject", "example": "Group Product" }, "description": { "type": "string", "description": "description for the media subject", "example": "Product media for a group of products." }, "displayOrder": { "type": "integer", "description": "display order for the media subject", "format": "int32", "example": 20 } }, "description": "Media Content Media Subject", "xml": { "name": "mediaContentMediaSubject" } }, "PartnerCommonService_GetMediaContentMediaAngleResponse": { "required": [ "mediaContentMediaAngles" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "mediaContentMediaAngles": { "type": "array", "description": "The Media Content Media Angles available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_MediaContentMediaAngle" } } }, "xml": { "name": "getMediaContentMediaAngleResponse" } }, "PartnerCommonService_MediaContentMediaAngle": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the media angle", "example": "BOTTOM" }, "name": { "type": "string", "description": "name for the media angle", "example": "Bottom" }, "description": { "type": "string", "description": "description for the media angle", "example": "Bottom" }, "displayOrder": { "type": "integer", "description": "display order for the media angle", "format": "int32", "example": 40 } }, "description": "Media Content Media Angle", "xml": { "name": "mediaContentMediaAngle" } }, "PartnerCommonService_GetMediaContentMediaBackgroundResponse": { "required": [ "mediaContentMediaBackgrounds" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "mediaContentMediaBackgrounds": { "type": "array", "description": "The Media Content Media Backgrounds available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_MediaContentMediaBackground" } } }, "xml": { "name": "getMediaContentMediaBackgroundResponse" } }, "PartnerCommonService_MediaContentMediaBackground": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the media background", "example": "LIFESTYLE" }, "name": { "type": "string", "description": "name for the media background", "example": "Lifestyle" }, "description": { "type": "string", "description": "description for the media background", "example": "Lifestyle background" }, "displayOrder": { "type": "integer", "description": "display order for the media background", "format": "int32", "example": 30 } }, "description": "Media Content Media Background", "xml": { "name": "mediaContentMediaBackground" } }, "PartnerCommonService_GetMediaContentMediaContentTypeResponse": { "required": [ "mediaContentMediaContentTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "mediaContentMediaContentTypes": { "type": "array", "description": "The Media Content Media Content Types available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_MediaContentMediaContentType" } } }, "xml": { "name": "getMediaContentMediaContentTypeResponse" } }, "PartnerCommonService_MediaContentMediaContentType": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the media content type", "example": "PRODUCT_TRY_ON" }, "name": { "type": "string", "description": "name for the media content type", "example": "Product Try-On" }, "description": { "type": "string", "description": "description for the media content type", "example": "Product Try-On" }, "displayOrder": { "type": "integer", "description": "display order for the media content type", "format": "int32", "example": 20 } }, "description": "Media Content Media Content Type", "xml": { "name": "mediaContentMediaContentType" } }, "PartnerCommonService_AssortmentDepartment": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the assortment department", "example": "WOMEN" }, "name": { "type": "string", "description": "name for the assortment department", "example": "Women" }, "description": { "type": "string", "description": "description for the assortment department", "example": "The audience for the assortment is Women." }, "displayOrder": { "type": "integer", "description": "display order for the assortment department", "format": "int32", "example": 10 } }, "description": "Assortment Department", "xml": { "name": "assortmentDepartment" } }, "PartnerCommonService_GetAssortmentDepartmentResponse": { "required": [ "assortmentDepartments" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "assortmentDepartments": { "type": "array", "description": "The Assortment Departments available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_AssortmentDepartment" } } }, "xml": { "name": "getAssortmentDepartmentResponse" } }, "PartnerCommonService_AssortmentHeaderStatus": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code describing an assortment header status", "example": "PENDING_ACTIVATION" }, "name": { "type": "string", "description": "name describing an assortment header status", "example": "Pending Activation" }, "description": { "type": "string", "description": "description describing an assortment header status", "example": "The assortment is in the design process, and has not yet been activated." }, "displayOrder": { "type": "integer", "description": "display order for the assortment header status", "format": "int32", "example": 10 } }, "description": "Assortment Header Status", "xml": { "name": "assortmentHeaderStatus" } }, "PartnerCommonService_GetAssortmentHeaderStatusesResponse": { "required": [ "assortmentHeaderStatuses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "assortmentHeaderStatuses": { "type": "array", "description": "The assortment header statuses available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_AssortmentHeaderStatus" } } }, "xml": { "name": "getAssortmentHeaderStatusesResponse" } }, "PartnerCommonService_AssortmentFashionStyle": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code describing an assortment fashion style", "example": "BOHEMIAN" }, "name": { "type": "string", "description": "name describing an assortment fashion style", "example": "Bohemian" }, "description": { "type": "string", "description": "description describing an assortment fashion style", "example": "Bohemian" }, "displayOrder": { "type": "integer", "description": "display order for the assortment fashion style", "format": "int32", "example": 10 } }, "description": "Assortment Header Status", "xml": { "name": "assortmentFashionStyle" } }, "PartnerCommonService_GetAssortmentFashionStylesResponse": { "required": [ "assortmentFashionStyles" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "assortmentFashionStyles": { "type": "array", "description": "The assortment fashion styles available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_AssortmentFashionStyle" } } }, "xml": { "name": "getAssortmentFashionStylesResponse" } }, "PartnerCommonService_FulfillmentCarrier": { "required": [ "carrierCode", "carrierDescription", "carrierDisplayOrder", "carrierName" ], "type": "object", "properties": { "carrierCode": { "type": "string", "description": "code for carrier", "example": "USPS" }, "carrierName": { "type": "string", "description": "name for the carrier", "example": "United States Postal Service (USPS)" }, "carrierDescription": { "type": "string", "description": "description for the carrier", "example": "United States Postal Service" }, "carrierDisplayOrder": { "type": "integer", "description": "display order for the carrier", "format": "int32", "example": 1 }, "carrierServices": { "type": "array", "description": "The list of services", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentCarrierService" } } }, "description": "Delivery service carrier", "xml": { "name": "fulfillmentCarrier" } }, "PartnerCommonService_FulfillmentCarrierService": { "required": [ "carrierServiceCode", "carrierServiceDescription", "carrierServiceDisplayOrder", "carrierServiceName" ], "type": "object", "properties": { "carrierServiceCode": { "type": "string", "description": "code for carrier service", "example": "USPS_FIRST_CLASS_MAIL" }, "carrierServiceName": { "type": "string", "description": "name for the carrier service", "example": "USPS First Class Mail" }, "carrierServiceDescription": { "type": "string", "description": "description for the carrier service", "example": "USPS First Class Mail" }, "carrierServiceAverageTransitTime": { "type": "string", "description": "average transit time for the carrier service", "example": "USPS First Class Mail" }, "carrierServiceDisplayOrder": { "type": "integer", "description": "display order for the carrier service", "format": "int32", "example": 1 }, "carrierServiceAdditionalServices": { "type": "array", "description": "The list of additional services", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentCarrierServiceAdditionalService" } } }, "description": "Delivery service carrier service", "xml": { "name": "fulfillmentCarrierService" } }, "PartnerCommonService_FulfillmentCarrierServiceAdditionalService": { "required": [ "carrierServiceAdditionalServiceCode", "carrierServiceAdditionalServiceDescription", "carrierServiceAdditionalServiceDisplayOrder", "carrierServiceAdditionalServiceName" ], "type": "object", "properties": { "carrierServiceAdditionalServiceCode": { "type": "string", "description": "code for carrier service additional service", "example": "USPS_FIRST_CLASS_MAIL_SIGNATURE_CONFIRMATION_ELECTRONIC" }, "carrierServiceAdditionalServiceName": { "type": "string", "description": "name for the carrier service additional service", "example": "First Class Mail Signature Confirmation Electronic" }, "carrierServiceAdditionalServiceDescription": { "type": "string", "description": "description for the carrier service additional service", "example": "Optimizes standard service packages for lowest price delivery service." }, "carrierServiceAdditionalServiceDisplayOrder": { "type": "integer", "description": "display order for thecarrier service additional service", "format": "int32", "example": 1 } }, "description": "Delivery service carrier service additional service", "xml": { "name": "fulfillmentCarrierServiceAdditionalService" } }, "PartnerCommonService_GetFulfillmentServiceOptionsResponse": { "required": [ "deliveryServiceOptions" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOptions": { "type": "array", "description": "The delivery service options", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentCarrier" } } }, "xml": { "name": "getFulfillmentServiceOptionsResponse" } }, "PartnerCommonService_GetOrderServiceOptionsResponse": { "required": [ "orderDeliveryServiceOptions" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderDeliveryServiceOptions": { "type": "array", "description": "The order delivery service options", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_OrderCarrier" } } }, "xml": { "name": "getOrderServiceOptionsResponse" } }, "PartnerCommonService_OrderCarrier": { "required": [ "orderCarrierCode", "orderCarrierDescription", "orderCarrierDisplayOrder", "orderCarrierName" ], "type": "object", "properties": { "orderCarrierCode": { "type": "string", "description": "code for carrier", "example": "USPS" }, "orderCarrierName": { "type": "string", "description": "name for the carrier", "example": "United States Postal Service (USPS)" }, "orderCarrierDescription": { "type": "string", "description": "description for the carrier", "example": "United States Postal Service" }, "orderCarrierDisplayOrder": { "type": "integer", "description": "display order for the carrier", "format": "int32", "example": 1 }, "orderCarrierServices": { "type": "array", "description": "The list of order services", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_OrderCarrierService" } } }, "description": "Order delivery service carrier", "xml": { "name": "orderCarrier" } }, "PartnerCommonService_OrderCarrierService": { "required": [ "orderCarrierServiceCode", "orderCarrierServiceDescription", "orderCarrierServiceDisplayOrder", "orderCarrierServiceName" ], "type": "object", "properties": { "orderCarrierServiceCode": { "type": "string", "description": "code for order carrier service", "example": "USPS_FIRST_CLASS_MAIL" }, "orderCarrierServiceName": { "type": "string", "description": "name for the order carrier service", "example": "USPS First Class Mail" }, "orderCarrierServiceDescription": { "type": "string", "description": "description for the order carrier service", "example": "USPS First Class Mail" }, "orderCarrierServiceAverageTransitTime": { "type": "string", "description": "average transit time for the order carrier service", "example": "USPS First Class Mail" }, "orderCarrierServiceDisplayOrder": { "type": "integer", "description": "display order for the order carrier service", "format": "int32", "example": 1 } }, "description": "Order delivery service carrier service", "xml": { "name": "orderCarrierService" } }, "PartnerCommonService_FulfillmentPackageLabelFormat": { "type": "object", "properties": { "code": { "type": "string", "description": "Package Label Format Code" }, "name": { "type": "string", "description": "Package Label Format Name" }, "description": { "type": "string", "description": "Package Label Format Description" }, "displayOrder": { "type": "integer", "description": "Package Label Format Display Order", "format": "int32" } }, "description": "The available package label formats", "xml": { "name": "fulfillmentPackageLabelFormat" } }, "PartnerCommonService_GetFulfillmentPackageLabelFormatsResponse": { "required": [ "fulfillmentPackageLabelFormats" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "fulfillmentPackageLabelFormats": { "type": "array", "description": "The available package label formats", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentPackageLabelFormat" } } }, "xml": { "name": "getFulfillmentPackageLabelFormatsResponse" } }, "PartnerCommonService_GetInstallmentBillingTermsResponse": { "required": [ "installmentBillingTermsList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "installmentBillingTermsList": { "type": "array", "description": "Installment Billing Terms List.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_InstallmentBillingTerms" } } }, "xml": { "name": "getInstallmentBillingTermsResponse" } }, "PartnerCommonService_InstallmentBillingTerms": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Installment billing term code", "example": "3_PAY" }, "name": { "type": "string", "description": "Installment billing term name", "example": "3_Pay" }, "description": { "type": "string", "description": "Installment billing terms description", "example": "The product style may be paid in 3 interest-free installments." }, "minStyleBasePrice": { "type": "number", "description": "The minimum style base price", "example": 13.52 }, "maxStyleBasePrice": { "type": "number", "description": "The maximum style base price", "example": 23.52 }, "displayOrder": { "type": "integer", "description": "Installment billing term display order", "format": "int32", "example": 1 } }, "description": "Partner Installment Billing Terms", "xml": { "name": "installmentBillingTerms" } }, "PartnerCommonService_GetBulkImportHeaderStatusResponse": { "required": [ "importHeaderStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "importHeaderStatus": { "type": "array", "description": "The set of Import Header Status.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerBulkImportService_ImportHeaderStatus" } } }, "xml": { "name": "getBulkImportHeaderStatusResponse" } }, "PartnerCommonService_GetCurationCommissionRatesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "getCurationCommissionRatesResponse" } }, "PartnerCommonService_CurationCommissionRateType": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for commission rate type", "example": "LOOK_COMMISSION" }, "name": { "type": "string", "description": "name for commission rate type", "example": "Look Commission" }, "description": { "type": "string", "description": "description for commission rate type", "example": "The rate is defined as a Look Commission Rate" }, "displayOrder": { "type": "integer", "description": "display order for commission rate type", "format": "int64", "example": 10 } }, "description": "The set of CurationCommissionRateType.", "xml": { "name": "curationCommissionRateType" } }, "PartnerCommonService_GetCurationCommissionRateTypeResponse": { "required": [ "curationCommissionRateTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "curationCommissionRateTypes": { "type": "array", "description": "The set of CurationCommissionRateType.", "xml": { "name": "curationCommissionRateType", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_CurationCommissionRateType" } } }, "xml": { "name": "getCurationCommissionRateTypeResponse" } }, "PartnerBulkImportService_SaveBulkInventoryAutoQueueEntryResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "saveBulkInventoryAutoQueueEntryResponse" } }, "SaveBulkInventoryAutoQueueEntryRequest": { "required": [ "externalFileName", "externalUsername" ], "type": "object", "properties": { "externalUsername": { "type": "string", "description": "External User Name " }, "externalFileName": { "type": "string", "description": "Filename to look for externally " } } }, "PartnerCommonService_GetUnitOfMeasureResponse": { "required": [ "unitsOfMeasure" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "unitsOfMeasure": { "type": "array", "description": "The available units of measure", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_UnitOfMeasure" } } }, "xml": { "name": "getUnitOfMeasureResponse" } }, "PartnerCommonService_CurationListHeaderType": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for list header type", "example": "PARTNER_CENTRAL" }, "name": { "type": "string", "description": "name for list header type", "example": "Partner Central" }, "description": { "type": "string", "description": "description for list header type", "example": "The list is only managed within Partner Central." }, "displayOrder": { "type": "integer", "description": "display order for list header type", "format": "int64", "example": 10 } }, "description": "The set of CurationListHeaderType.", "xml": { "name": "curationListHeaderType" } }, "PartnerCommonService_GetCurationListHeaderTypeResponse": { "required": [ "curationListHeaderTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "curationListHeaderTypes": { "type": "array", "description": "The set of CurationListHeaderType.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_CurationListHeaderType" } } }, "xml": { "name": "getCurationListHeaderTypeResponse" } }, "PartnerCommonService_BankTransferCountry": { "required": [ "countryDisplayName", "countryIso2Code", "countryIso3Code", "countryIsoName", "countryIsoNumeric", "displayOrder" ], "type": "object", "properties": { "countryDisplayName": { "type": "string", "description": "Display name of the country", "example": "United States" }, "countryIsoName": { "type": "string", "description": "Iso name of the country", "example": "United States of America" }, "countryIso2Code": { "type": "string", "description": "Iso2 code of the country", "example": "US" }, "countryIso3Code": { "type": "string", "description": "Iso3 code of the country", "example": "USA" }, "countryIsoNumeric": { "type": "integer", "description": "IsoNumeric code of the country", "format": "int32", "example": 840 }, "displayOrder": { "type": "integer", "description": "The order to display among other countries", "format": "int32", "example": 5 } }, "description": "Bank Transfer Country", "xml": { "name": "bankTransferCountry" } }, "PartnerCommonService_GetBankTransferCountriesResponse": { "required": [ "bankTransferCountries", "totalCountries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalCountries": { "type": "integer", "description": "Total countries", "format": "int32", "example": 25 }, "bankTransferCountries": { "type": "array", "description": "List of Bank transfer countries", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_BankTransferCountry" } } }, "xml": { "name": "getBankTransferCountriesResponse" } }, "PartnerCommonService_GetStandardDateRangeListResponse": { "required": [ "standardDateRangeList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "standardDateRangeList": { "type": "array", "description": "List of standard date ranges.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_StandardDateRange" } } }, "xml": { "name": "getStandardDateRangeListResponse" } }, "PartnerCommonService_StandardDateRange": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the standard date range", "example": "TODAY" }, "name": { "type": "string", "description": "name for the standard date range", "example": "Today" }, "description": { "type": "string", "description": "code for the standard date range", "example": "Transactions returned are only for the current_date." }, "displayOrder": { "type": "integer", "description": "code for the standard date range", "format": "int64", "example": 1 } }, "description": "Bank Transfer Country Config", "xml": { "name": "standardDateRange" } }, "PartnerCommonService_GetSpecializationResponse": { "required": [ "specialization" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "specialization": { "type": "array", "description": "The User Profile specializations available.", "xml": { "name": "specializations", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_Specialization" } } }, "xml": { "name": "getSpecializationResponse" } }, "PartnerCommonService_Specialization": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop user specialization", "example": "BRIDAL_JEWELRY" }, "name": { "type": "string", "description": "name for the shop user specialization", "example": "Bridal Jewelry" }, "description": { "type": "string", "description": "description for the shop user specialization", "example": "Bridal Jewelry" }, "displayOrder": { "type": "integer", "description": "display order for the shop user specialization", "format": "int32", "example": 1 } }, "description": "User Profile Specialization", "xml": { "name": "specialization" } }, "PartnerCommonService_FulfillmentShipmentStatus": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the fulfillment shipment header status", "example": "PENDING_RELEASE" }, "name": { "type": "string", "description": "name for the fulfillment shipment header status", "example": "Pending Release" }, "description": { "type": "string", "description": "description for the fulfillment shipment header status", "example": "The shipment is fully defined and is pending release to the Partner." }, "displayOrder": { "type": "integer", "description": "display order for the fulfillment shipment header status", "format": "int32", "example": 1 }, "fulfillmentStatusClassifications": { "type": "array", "description": "Describes the status classification for a shipment header.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentShipmentStatusClassification" } } }, "description": "Partner Fulfillment Shipment Header Status", "xml": { "name": "fulfillmentShipmentStatus" } }, "PartnerCommonService_FulfillmentShipmentStatusClassification": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the fulfillment shipment status classification", "example": "IN_PROGRESS" }, "name": { "type": "string", "description": "name for the fulfillment shipment status classification", "example": "In Progress" }, "description": { "type": "string", "description": "description for the fulfillment shipment status classification", "example": "The shipment is in the process of being fulfilled." }, "displayOrder": { "type": "integer", "description": "display order for the fulfillment shipment status classification", "format": "int32", "example": 1 } }, "description": "Partner Fulfillment Shipment Status Classification", "xml": { "name": "fulfillmentShipmentStatusClassification" } }, "PartnerCommonService_GetFulfillmentShipmentStatusResponse": { "required": [ "fulfillmentShipmentStatuses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "fulfillmentShipmentStatuses": { "type": "array", "description": "The Partner Fulfillment Statuses available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentShipmentStatus" } } }, "xml": { "name": "getFulfillmentShipmentStatusResponse" } }, "PartnerCommonService_GetFulfillmentShipmentStatusClassificationResponse": { "required": [ "fulfillmentShipmentStatusClassifications" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "fulfillmentShipmentStatusClassifications": { "type": "array", "description": "The Partner Fulfillment Shipment Status Classification available.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentShipmentStatusClassification" } } }, "xml": { "name": "getFulfillmentShipmentStatusClassificationResponse" } }, "PartnerCommonService_GetOptimizationRulesResponse": { "required": [ "optimizationRules" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "optimizationRules": { "type": "array", "description": "The delivery service optimization rule.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_OptimizationRule" } } }, "xml": { "name": "getOptimizationRulesResponse" } }, "PartnerCommonService_OptimizationRule": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the optimization rule", "example": "STANDARD_LOWEST_PRICE" }, "name": { "type": "string", "description": "name for the optimization rule", "example": "Standard - Lowest Price" }, "description": { "type": "string", "description": "description for the optimization rule", "example": "Optimizes standard service packages for lowest price delivery service." }, "displayOrder": { "type": "integer", "description": "display order for the optimization rule", "format": "int32", "example": 1 } }, "description": "Delivery service optimization rule", "xml": { "name": "optimizationRule" } }, "PartnerCommonService_GetReceiptLineTypesResponse": { "required": [ "receiptLineTypeList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptLineTypeList": { "type": "array", "description": "The available receipt line types", "xml": { "name": "ReceiptLineTypes", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptLineType" } } }, "xml": { "name": "getReceiptLineTypesResponse" } }, "PartnerCommonService_ReceiptLineType": { "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Line Type Code" }, "name": { "type": "string", "description": "Receipt Line Type Name" }, "description": { "type": "string", "description": "Receipt Line Type Description" }, "displayOrder": { "type": "integer", "description": "Receipt Line Type Display Order", "format": "int32" } }, "description": "The available receipt line types", "xml": { "name": "ReceiptLineType" } }, "PartnerCommonService_GetProductListingLabelsResponse": { "required": [ "productListingLabelList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "productListingLabelList": { "type": "array", "description": "The available product listing labels", "xml": { "name": "ProductListingLabel", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ProductListingLabel" } } }, "xml": { "name": "getProductListingLabelsResponse" } }, "PartnerCommonService_ProductListingLabel": { "type": "object", "properties": { "code": { "type": "string", "description": "Product Listing Label Code" }, "name": { "type": "string", "description": "Product Listing Label Name" }, "description": { "type": "string", "description": "Product Listing Label Description" }, "displayOrder": { "type": "integer", "description": "Product Listing Label Display Order", "format": "int32" } }, "description": "The available product listing labels", "xml": { "name": "ProductListingLabel" } }, "PartnerCommonService_GetReceiptLineReasonGroupsResponse": { "required": [ "receiptLineReasonGroupList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptLineReasonGroupList": { "type": "array", "description": "The available receipt line reason groups", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptLineReasonGroup" } } }, "xml": { "name": "getReceiptLineReasonGroupsResponse" } }, "PartnerCommonService_ReceiptLineReason": { "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Line Reason Code" }, "name": { "type": "string", "description": "Receipt Line Reason Name" }, "description": { "type": "string", "description": "Receipt Line Reason Description" }, "displayOrder": { "type": "integer", "description": "Receipt Line Reason Display Order", "format": "int32" } }, "description": "The available receipt line reasons", "xml": { "name": "receiptLineReason" } }, "PartnerCommonService_ReceiptLineReasonGroup": { "required": [ "receiptLineReasonList" ], "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Line Reason Group Code" }, "name": { "type": "string", "description": "Receipt Line Reason Group Name" }, "description": { "type": "string", "description": "Receipt Line Reason Group Description" }, "displayOrder": { "type": "integer", "description": "Receipt Line Reason Group Display Order", "format": "int32" }, "receiptLineReasonList": { "type": "array", "description": "The available receipt line reasons", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptLineReason" } } }, "description": "The available receipt line reason groups", "xml": { "name": "receiptLineReasonGroup" } }, "PartnerCommonService_GetReceiptLineCancelReasonGroupsResponse": { "required": [ "receiptLineCancelReasonGroupList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptLineCancelReasonGroupList": { "type": "array", "description": "The available receipt line cancel reason groups", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptLineCancelReasonGroup" } } }, "xml": { "name": "getReceiptLineCancelReasonGroupsResponse" } }, "PartnerCommonService_ReceiptLineCancelReason": { "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Line Cancel Reason Code" }, "name": { "type": "string", "description": "Receipt Line Cancel Reason Name" }, "description": { "type": "string", "description": "Receipt Line Cancel Reason Description" }, "displayOrder": { "type": "integer", "description": "Receipt Line Cancel Reason Display Order", "format": "int32" } }, "description": "The available receipt line cancel reasons", "xml": { "name": "receiptLineCancelReason" } }, "PartnerCommonService_ReceiptLineCancelReasonGroup": { "required": [ "receiptLineCancelReasonList" ], "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Line Cancel Reason Group Code" }, "name": { "type": "string", "description": "Receipt Line Cancel Reason Group Name" }, "description": { "type": "string", "description": "Receipt Line Cancel Reason Group Description" }, "displayOrder": { "type": "integer", "description": "Receipt Line Cancel Reason Group Display Order", "format": "int32" }, "receiptLineCancelReasonList": { "type": "array", "description": "The available receipt line cancel reasons", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptLineCancelReason" } } }, "description": "The available receipt line cancel reason groups", "xml": { "name": "receiptLineCancelReasonGroup" } }, "PartnerCommonService_GetReceiptHeaderStatusClassificationsResponse": { "required": [ "receiptHeaderStatusClassifications" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptHeaderStatusClassifications": { "type": "array", "description": "The available receipt header status classifications", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptHeaderStatusClassification" } } }, "xml": { "name": "getReceiptHeaderStatusClassificationsResponse" } }, "PartnerCommonService_ReceiptHeaderStatusClassification": { "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Header Status Classification Code" }, "name": { "type": "string", "description": "Receipt Header Status Classification Name" }, "description": { "type": "string", "description": "Receipt Header Status Classification Description" }, "displayOrder": { "type": "integer", "description": "Receipt Header Status Classification Display Order", "format": "int32" } }, "description": "The available receipt header status classifications", "xml": { "name": "receiptHeaderStatusClassification" } }, "PartnerCommonService_GetReceiptHeaderStatusListResponse": { "required": [ "receiptHeaderStatusList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptHeaderStatusList": { "type": "array", "description": "The available receipt header statuses", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ReceiptHeaderStatus" } } }, "xml": { "name": "getReceiptHeaderStatusResponse" } }, "PartnerCommonService_ReceiptHeaderStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Receipt Header Status Code" }, "name": { "type": "string", "description": "Receipt Header Status Name" }, "description": { "type": "string", "description": "Receipt Header Status Description" }, "displayOrder": { "type": "integer", "description": "Receipt Header Status Display Order", "format": "int32" } }, "description": "The available receipt header statuses", "xml": { "name": "receiptHeaderStatus" } }, "PartnerCommonService_GetBulkImportHeaderTypeListResponse": { "required": [ "importHeaderTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "importHeaderTypes": { "type": "array", "description": "The set of Import Header Types.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_ImportHeaderType" } } }, "xml": { "name": "getBulkImportHeaderTypeListResponse" } }, "PartnerCommonService_ListingMediaConflictActionOption": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for listing media conflict action option", "example": "INSERT_AND_SHIFT" }, "name": { "type": "string", "description": "name for listing media conflict action option", "example": "Insert and Shift" }, "description": { "type": "string", "description": "description for listing media conflict action option", "example": "The Bulk Import processor shall Insert the media item in the conflicting position, and it shall Shift the conflicting media item, as well as any which follow, down in position to a higher position number. For example, if there is a conflict in Position 3, and media items exist in Position 4 and 5, then the new media item will be created in Position 3, and the media items which were previously in Positions 3, 4, and 5 shall be shifted to Positions 4, 5, and 6." }, "displayOrder": { "type": "integer", "description": "display order for listing media delimiter character", "format": "int64", "example": 10 } }, "description": "The class of listing media conflict action options", "xml": { "name": "listingMediaConflictActionOption" } }, "PartnerCommonService_ListingMediaDelimiterCharacters": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for listing media delimiter character", "example": "NO_DELIMITER" }, "name": { "type": "string", "description": "name for listing media delimiter character", "example": "No Delimiter" }, "description": { "type": "string", "description": "description for listing media delimiter character", "example": "No delimiter exists within the filename." }, "displayOrder": { "type": "integer", "description": "display order for listing media delimiter character", "format": "int64", "example": 10 } }, "description": "The class of listing media delimiter characters", "xml": { "name": "listingMediaDelimiterCharacters" } }, "PartnerCommonService_ListingMediaMappingMethods": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for listing media mapping method", "example": "MEDIA_FILENAME" }, "name": { "type": "string", "description": "name for listing media mapping method", "example": "Media Filename" }, "description": { "type": "string", "description": "description for listing media mapping method", "example": "The mapping shall be accomplished by parsing the media filename." }, "displayOrder": { "type": "integer", "description": "display order for listing media mapping method", "format": "int64", "example": 10 } }, "description": "The class of listing media mapping methods", "xml": { "name": "listingMediaMappingMethods" } }, "PartnerCommonService_FulfillmentLeadTime": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the fulfillment lead time in days.", "example": "DAY_3" }, "name": { "type": "string", "description": "The name representing the fulfillment lead time in days.", "example": "1 Day" }, "description": { "type": "string", "description": "The description for the fulfillment lead time in days.", "example": "3 day duration for fulfillment before shipment." } }, "description": "Describes an available metric for measurement", "xml": { "name": "fulfillmentLeadTime" } }, "PartnerCommonService_GetFulfillmentLeadTimeResponse": { "required": [ "fulfillmentLeadTimes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "fulfillmentLeadTimes": { "type": "array", "description": "The available fulfillment lead times", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCommonService_FulfillmentLeadTime" } } }, "xml": { "name": "getFulfillmentLeadTimeResponse" } }, "PartnerCurationAssortmentService_CreatePartnerCurationAssortmentHeaderResponse": { "required": [ "curationAssortmentHeaderId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "curationAssortmentHeaderId": { "type": "string", "description": "The unique identifier for the curation assortment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerCurationAssortmentHeaderResponse" } }, "PartnerCurationAssortmentService_CreatePartnerCurationAssortmentHeaderRequest": { "required": [ "assortmentTitle", "curatorId" ], "type": "object", "properties": { "assortmentTitle": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The unique identifier for the associate permission.", "example": "The Greatest Assortment of the Best Jewels Ever Mined" }, "curatorId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the curator.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "assortmentDepartmentCodes": { "type": "array", "description": "A list of assortment department codes.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of assortment department codes.", "xml": { "name": "assortmentDepartmentCode" } } }, "assortmentFashionStyleCodes": { "type": "array", "description": "A list of assortment fashion style codes.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of assortment fashion style codes.", "xml": { "name": "assortmentFashionStyleCode" } } } }, "xml": { "name": "createPartnerCurationAssortmentHeaderRequest" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAssortmentDepartment": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Department code", "example": "WOMEN" }, "name": { "type": "string", "description": "Department name", "example": "Women" }, "description": { "type": "string", "description": "Description of the department", "example": "The audience for the assortment is Women." } }, "description": "Assortment Header Departments", "xml": { "name": "getPartnerCurationAssortmentHeaderAssortmentDepartment" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAuditInfo": { "required": [ "createDateTime", "createUser" ], "type": "object", "properties": { "createUser": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAuditInfoUser" }, "modifiedUser": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAuditInfoUser" }, "createDateTime": { "type": "string", "description": "Creation datetime.", "format": "date-time", "example": "2022-05-27T14:18:36.03-05:00" }, "modifiedDateTime": { "type": "string", "description": "Modification datetime.", "format": "date-time", "example": "2022-05-29T14:18:36.03-05:00" } }, "xml": { "name": "getPartnerCurationAssortmentHeaderAuditInfo" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAuditInfoUser": { "required": [ "firstName", "lastName", "userUuid" ], "type": "object", "properties": { "userUuid": { "type": "string", "description": "Create user uuid.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "firstName": { "type": "string", "description": "Create user first name.", "example": "James" }, "lastName": { "type": "string", "description": "Create user last name.", "example": "Baker" } }, "xml": { "name": "getPartnerCurationAssortmentHeaderAuditInfoUser" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderCuratorProfile": { "required": [ "firstName", "lastName", "profileId" ], "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique identifier for the curation assortment curator.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "firstName": { "type": "string", "description": "Curator first name.", "example": "James" }, "lastName": { "type": "string", "description": "Curator last name.", "example": "Jones" } }, "description": "Assortment Curator Profile", "xml": { "name": "getPartnerCurationAssortmentHeaderCuratorProfile" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderResponse": { "required": [ "partnerCurationAssortmentHeaderDetail" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerCurationAssortmentHeaderDetail": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_PartnerCurationAssortmentHeaderDetail" } }, "xml": { "name": "getPartnerCurationAssortmentHeaderResponse" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code for the assortment header status", "example": "ACTIVE" }, "name": { "type": "string", "description": "The name for the assortment header status", "example": "Active" }, "description": { "type": "string", "description": "The description for the assortment header status", "example": "Active" } }, "description": "The assortment's status information", "xml": { "name": "getPartnerCurationAssortmentHeaderStatus" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentStyleFashion": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the assortment style fashion.", "example": "BOHEMIAN" }, "name": { "type": "string", "description": "Name of assortment style fashion.", "example": "Bohemian" }, "description": { "type": "string", "description": "Description of the assortment style fashion.", "example": "Bohemian style" } }, "description": "Assortment Header Style Fashions", "xml": { "name": "getPartnerCurationAssortmentHeaderStyleFashion" } }, "PartnerCurationAssortmentService_PartnerCurationAssortmentHeaderDetail": { "required": [ "assortmentCreateDate", "assortmentDepartments", "assortmentHeaderId", "assortmentNumber", "assortmentStatus", "assortmentTitle", "auditInfo", "curatorProfile", "totalAssortmentStyleQuantity" ], "type": "object", "properties": { "assortmentHeaderId": { "type": "string", "description": "The unique identifier for the curation assortment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "assortmentNumber": { "type": "string", "description": "Assortment number.", "example": "CAB302LWH17PSR" }, "assortmentStatus": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderStatus" }, "assortmentCreateDate": { "type": "string", "description": "Creation date of the assortment.", "format": "date-time", "example": "2022-04-16T08:15:08.305-05:00" }, "assortmentTitle": { "type": "string", "description": "Title of the assortment.", "example": "Summer Necklaces" }, "assortmentDepartments": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAssortmentDepartment" } }, "assortmentStyleFashions": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentStyleFashion" } }, "curatorProfile": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderCuratorProfile" }, "auditInfo": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAuditInfo" }, "totalAssortmentStyleQuantity": { "type": "integer", "description": "Description 5", "format": "int32" } }, "description": "Detailed information identifying a specific assortment header.", "xml": { "name": "PartnerCurationAssortmentHeaderDetail" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderListResponse": { "required": [ "totalAssortmentCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalAssortmentCount": { "type": "integer", "description": "totalAssortmentCount", "format": "int32", "example": 10 }, "partnerCurationAssortmentHeaderSummaries": { "type": "array", "description": "The paged list of assortment headers that satisfy the filter criteria.", "xml": { "name": "partnerAssortmentHeaderSummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_PartnerCurationAssortmentHeaderSummary" } } }, "xml": { "name": "getPartnerCurationAssortmentHeaderListResponse" } }, "PartnerCurationAssortmentService_PartnerCurationAssortmentHeaderSummary": { "type": "object", "properties": { "assortmentHeaderId": { "type": "string", "description": "A unique identifier for an assortment header", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "assortmentNumber": { "type": "string", "description": "A unique string representing assortment headers", "example": "CA7V8GTR3Y242J" }, "assortmentTitle": { "type": "string", "description": "The assortment's title", "example": "Beautiful Fall Jewelry" }, "assortmentStatus": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderStatus" }, "assortmentCreateDate": { "type": "string", "description": "The assortment's create date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "assortmentDepartments": { "type": "array", "description": "Assortment Header Departments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderAssortmentDepartment" } }, "assortmentStyleFashions": { "type": "array", "description": "Assortment Header Style Fashions", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentStyleFashion" } }, "curatorProfile": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_GetPartnerCurationAssortmentHeaderCuratorProfile" }, "totalAssortmentStyleQuantity": { "type": "integer", "description": "The total number of styles in the assortment", "format": "int32", "example": 5 } }, "description": "A curation assortment header.", "xml": { "name": "partnerCurationAssortmentHeaderSummary" } }, "DateParameter": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } } }, "PartnerCurationAssortmentService_UpdatePartnerCurationAssortmentLinesResponse": { "required": [ "assortmentLineIds" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "assortmentLineIds": { "type": "array", "description": "List of assortment line IDs which have been updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "items": { "type": "string", "description": "List of assortment line IDs which have been updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "assortmentLineIds" } } } }, "xml": { "name": "updatePartnerCurationAssortmentLinesResponse" } }, "PartnerCurationAssortmentService_UpdateAssortmentLineInfo": { "required": [ "assortmentLineId", "valueStatement" ], "type": "object", "properties": { "assortmentLineId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the assortment line ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "valueStatement": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "Value statement for the assortment line.", "example": "This is a great piece for a night out on the town." } }, "description": "Partner curation assortment line info.", "xml": { "name": "updateAssortmentLineInfo" } }, "PartnerCurationAssortmentService_UpdatePartnerCurationAssortmentLinesRequest": { "required": [ "updateAssortmentLines" ], "type": "object", "properties": { "updateAssortmentLines": { "type": "array", "description": "The assortment lines for update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_UpdateAssortmentLineInfo" } } }, "xml": { "name": "updatePartnerCurationAssortmentLinesRequest" } }, "PartnerCurationAssortmentService_CreateCurationAssortmentLineResult": { "required": [ "assortmentLineId", "resultStatus" ], "type": "object", "properties": { "echoId": { "type": "string", "description": "The optional client provided id that will be returned untouched by the service.", "example": "ABC-1" }, "assortmentLineId": { "type": "string", "description": "The Assortment Line Id for the curation assortment.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "errorCode": { "type": "string", "description": "The errorCode for the curation assortment line." }, "errorMessage": { "type": "string", "description": "The errorMessage for the curation assortment line." }, "resultStatus": { "type": "string", "description": "The status for the create curation assortment line request." } }, "description": "A create curation assortment line result", "xml": { "name": "CreateCurationAssortmentLineResult" } }, "PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "createCurationAssortmentLineResults": { "type": "array", "description": "List of requested curation list lines for creation with results", "xml": { "name": "createCurationListLineResults", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreateCurationAssortmentLineResult" } } }, "xml": { "name": "createPartnerCurationAssortmentLinesResponse" } }, "PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLines": { "required": [ "styleListingId" ], "type": "object", "properties": { "echoId": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The optional client provided id that will be returned untouched by the service.", "example": "ABC-1" }, "styleListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "Style Listing ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "valueStatement": { "maxLength": 1000, "minLength": 0, "type": "string", "description": "The value statement" } }, "description": "Create Partner Curation Assortment Lines", "xml": { "name": "createPartnerCurationAssortmentLines" } }, "PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLinesRequest": { "required": [ "createPartnerCurationAssortmentLines" ], "type": "object", "properties": { "createPartnerCurationAssortmentLines": { "type": "array", "description": "Create Partner Curation Assortment Lines", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentService_CreatePartnerCurationAssortmentLines" } } }, "xml": { "name": "createPartnerCurationAssortmentLinesRequest" } }, "PartnerCurationAssortmentService_DeletePartnerCurationAssortmentLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerCurationAssortmentLinesResponse" } }, "PartnerCurationAssortmentService_DeletePartnerCurationAssortmentLinesRequest": { "required": [ "assortmentLineIds" ], "type": "object", "properties": { "assortmentLineIds": { "type": "array", "description": "A list of unique identifiers for assortment lines to be deleted.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of unique identifiers for assortment lines to be deleted.", "xml": { "name": "assortmentLineId" } } } }, "xml": { "name": "deletePartnerCurationAssortmentLinesRequest" } }, "AssortmentLineAuditInfo": { "type": "object", "properties": { "createdUser": { "$ref": "#/components/schemas/AuditUser" }, "modifiedUser": { "$ref": "#/components/schemas/AuditUser" }, "createdDateTime": { "type": "string", "description": "Creation date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "modifiedDateTime": { "type": "string", "description": "Modification date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Information regarding the assortment line creation and update user and time.", "xml": { "name": "PartnerInfo" } }, "AssortmentLineCommissionRateSchedule": { "type": "object", "properties": { "commissionType": { "$ref": "#/components/schemas/CommissionType" }, "commissionRate": { "$ref": "#/components/schemas/CommissionRate" }, "rate": { "type": "number", "description": "The commission rate. ( dollars or percent )", "format": "double", "example": 2.0 }, "commissionAmount": { "type": "number", "description": "The commission amount.", "format": "double", "example": 5.0 } }, "description": "Information regarding the assortment line's commission rate schedules", "xml": { "name": "AssortmentLineCommissionRateSchedule" } }, "AssortmentLinePartnerInfo": { "type": "object", "properties": { "partnerId": { "type": "string", "description": "The Partner's unique ID", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "store": { "$ref": "#/components/schemas/ListingStore" }, "operatingName": { "type": "string", "description": "The Partner's Operating Name", "example": "ABC Jewelry Associates, Inc." }, "businessAddress": { "$ref": "#/components/schemas/BusinessAddress" } }, "description": "Information regarding the assortment line's style listing partner", "xml": { "name": "AssortmentLinePartnerInfo" } }, "AssortmentLineStyleHeader": { "type": "object", "properties": { "styleListingId": { "type": "string", "description": "The Style Listing ID for the curation List Line", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "styleNumber": { "type": "string", "description": "The Style Number for the curation List Line.", "example": "EOV1202" }, "styleImageUrl": { "type": "string", "description": "The style's image URL", "example": "https://images.jtv.com/EOV1202.jpg" }, "supplierStyleNumber": { "type": "string", "description": "The supplier's style number", "example": "MCGDOCV565" }, "styleStatus": { "$ref": "#/components/schemas/StyleStatus" }, "styleTitleDescription": { "type": "string", "description": "The style's title description", "example": "Ethiopian Opal 14x10mm Oval Set 5.01ctw" }, "basePrice": { "type": "number", "description": "The style's base price", "format": "double", "example": 10.5 }, "discountPrice": { "type": "number", "description": "The style's discount price", "format": "double", "example": 2.5 }, "fulfillmentService": { "$ref": "#/components/schemas/FulfillmentService" }, "totalSizes": { "type": "integer", "description": "The style's total number of sizes", "format": "int32", "example": 2 }, "totalAvailableUnits": { "type": "integer", "description": "The style's total available units", "format": "int32", "example": 20 } }, "description": "Information regarding the assortment line's style header", "xml": { "name": "AssortmentLineStyleHeader" } }, "AuditUser": { "type": "object", "properties": { "userAccountId": { "type": "string", "description": "User's unique account ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "firstName": { "type": "string", "description": "User's first name.", "example": "James" }, "lastName": { "type": "string", "description": "User's last name.", "example": "Baker" } }, "description": "The Modified User", "xml": { "name": "AuditUser" } }, "BusinessAddress": { "type": "object", "properties": { "addressId": { "type": "string", "description": "The Business Address ID", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "addressLine1": { "type": "string", "description": "First line of the address", "example": "9600 Parkside Drive" }, "addressLine2": { "type": "string", "description": "Optional second line of the address", "example": "ATTN: Information Technology" }, "addressLine3": { "type": "string", "description": "Optional third line of the address", "example": "Room: P132" }, "city": { "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "type": "string", "description": "Address state or province abbreviation", "example": "TN" }, "zip": { "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922" }, "country": { "type": "string", "description": "Address country abbreviation", "example": "USA" } }, "description": "The Partner's Business Address", "xml": { "name": "BusinessAddress" } }, "CommissionMethod": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for this commission method.", "example": "FIXED_RATE_PERCENTAGE_OF_SELLING_PRICE" }, "name": { "type": "string", "description": "The name for this commission method.", "example": "Fixed Rate Percentage of Selling Price" }, "description": { "type": "string", "description": "The description for this commission method.", "example": "A Fixed Rate Percentage of the Selling Price is defined." } }, "description": "The commission method.", "xml": { "name": "CommissionMethod" } }, "CommissionRate": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the commission rate.", "example": "10_PERCENT" }, "name": { "type": "string", "description": "The name for the commission rate.", "example": "1.0%" }, "description": { "type": "string", "description": "The description for the commission rate.", "example": "1.0%" }, "commissionMethod": { "$ref": "#/components/schemas/CommissionMethod" } }, "description": "The commission rate.", "xml": { "name": "CommissionRate" } }, "CommissionType": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the commission type.", "example": "LOOK_COMMISSION" }, "name": { "type": "string", "description": "The name for the commission type.", "example": "Look Commission" }, "description": { "type": "string", "description": "The description for the commission type.", "example": "A commission paid for a Curated Look" } }, "description": "The commission rate type.", "xml": { "name": "CommissionType" } }, "FulfillmentService": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the fulfillment service.", "example": "BJMS_THIRD_PARTY_FULFILLMENT" }, "name": { "type": "string", "description": "The name for the fulfillment service.", "example": "Fulfillment by Jedora" }, "description": { "type": "string", "description": "The description for the Fulfillment Service.", "example": "The Fulfillment by Jedora service allows sellers to utilize Jedora for their robust storage, fulfillment, and logistics services." } }, "description": "The style's fulfillment service", "xml": { "name": "FulfillmentService" } }, "ListingStore": { "type": "object", "properties": { "storeId": { "type": "string", "description": "The Store UUID", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "storeNumber": { "type": "string", "description": "The Store's Number" }, "storeDisplayName": { "type": "string", "description": "The Store's Display Name" } }, "description": "The Partner's Store", "xml": { "name": "store" } }, "PartnerCurationAssortmentLineDetail": { "required": [ "assortmentLineAuditInfo", "assortmentLineCommissionRateSchedules", "assortmentLineId", "assortmentLinePartnerInfo", "assortmentLineStyleHeader", "productNumber", "valueStatement" ], "type": "object", "properties": { "assortmentLineId": { "type": "string", "description": "The unique code representing a assortment line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "productNumber": { "type": "string", "description": "The product number for the assortment line", "example": "DQK998" }, "valueStatement": { "type": "string", "description": "Information regarding the assortment line's value statement", "example": "This ring really makes you feel like you're a wizard." }, "assortmentLineStyleHeader": { "$ref": "#/components/schemas/AssortmentLineStyleHeader" }, "assortmentLineCommissionRateSchedules": { "type": "array", "description": "Information regarding the assortment line's commission rate schedules", "items": { "$ref": "#/components/schemas/AssortmentLineCommissionRateSchedule" } }, "assortmentLinePartnerInfo": { "$ref": "#/components/schemas/AssortmentLinePartnerInfo" }, "assortmentLineAuditInfo": { "$ref": "#/components/schemas/AssortmentLineAuditInfo" } }, "description": "The paged list of assortment lines", "xml": { "name": "PartnerCurationAssortmentLineDetail" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentLineResponse": { "required": [ "partnerCurationAssortmentLineDetail" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerCurationAssortmentLineDetail": { "$ref": "#/components/schemas/PartnerCurationAssortmentLineDetail" } }, "xml": { "name": "getPartnerCurationAssortmentLineResponse" } }, "StyleStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the style status.", "example": "ACTIVE" }, "name": { "type": "string", "description": "The name for the style status.", "example": "Active" }, "description": { "type": "string", "description": "The description for the style status.", "example": "The style listing is Active" } }, "description": "The listing status for the curation list line's style.", "xml": { "name": "StyleStatus" } }, "PartnerCurationAssortmentService_DeletePartnerCurationAssortmentHeaderResponse": { "required": [ "assortmentHeaderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "assortmentHeaderUuid": { "type": "string", "description": "The unique code representing the deleted delivery assortment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "deletePartnerCurationAssortmentHeaderResponse" } }, "PartnerCurationAssortmentService_GetPartnerCurationAssortmentLinesResponse": { "required": [ "totalStyleCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalStyleCount": { "type": "integer", "description": "The total number of assortment lines available for the assortment header.", "format": "int32", "example": 27 }, "assortmentLines": { "type": "array", "description": "The paged list of assortment lines", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationAssortmentLineDetail" } } }, "xml": { "name": "getPartnerCurationAssortmentLinesResponse" } }, "PartnerCurationListService_GetPartnerCurationListResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "curationListResults": { "type": "array", "description": "List of uuids of partner curation list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationListService_GetPartnerCurationListResult" } } }, "xml": { "name": "getPartnerCurationListResponse" } }, "PartnerCurationListService_GetPartnerCurationListResult": { "required": [ "listNumber" ], "type": "object", "properties": { "listNumber": { "type": "string", "description": "The listNumber for the curation list." } }, "description": "A curation list service", "xml": { "name": "GetPartnerCurationListResult" } }, "PartnerCurationProfileService_CuratorProfile": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique code representing an delivery service order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "firstName": { "type": "string", "description": "The employee's first name", "example": "Billy" }, "lastName": { "type": "string", "description": "The employee's last name", "example": "Thomas" } }, "description": "A Curator Profile", "xml": { "name": "curatorProfile" } }, "PartnerCurationProfileService_GetPartnerCurationProfileResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "curators": { "type": "array", "description": "The paged list of delivery service orders that satisfy the filter criteria.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationProfileService_CuratorProfile" } } }, "xml": { "name": "getPartnerCurationProfileResponse" } }, "PartnerCurationRateScheduleService_CreateCurationRateScheduleResult": { "required": [ "resultStatus", "styleRateScheduleId" ], "type": "object", "properties": { "echoId": { "type": "string", "description": "A unique surrogate-key (string) used for each request list element so you are able to absolutely identitify the corresponding response list elements just in case the list order is not maintained during the API request." }, "styleRateScheduleId": { "type": "string", "description": "The styleRateScheduleId for the curation rate schedule." }, "errorCode": { "type": "string", "description": "The errorCode for the curation rate schedule." }, "errorMessage": { "type": "string", "description": "The errorMessage for the curation rate schedule." }, "resultStatus": { "type": "string", "description": "The status for the create curation rate schedule request." } }, "description": "A create rate schedule result", "xml": { "name": "CreateCurationRateScheduleResult" } }, "PartnerCurationRateScheduleService_CreatePartnerCurationRateScheduleResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "curationRateScheduleResults": { "type": "array", "description": "List of requested curation rate schedules for creation with results", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CreateCurationRateScheduleResult" } } }, "xml": { "name": "createPartnerCurationRateScheduleResponse" } }, "PartnerCurationRateScheduleService_CreateCurationRateSchedule": { "required": [ "curationRateCode", "curationRateTypeCode", "styleListingId" ], "type": "object", "properties": { "echoId": { "maxLength": 100, "minLength": 0, "type": "string", "description": "A unique surrogate-key (string) used for each request list element so you are able to absolutely identitify the corresponding response list elements just in case the list order is not maintained during the API request.", "example": "A unique surrogate-key (string) used for each request list element so you are able to absolutely identitify the corresponding response list elements just in case the list order is not maintained during the API request." }, "styleListingId": { "maxLength": 100, "minLength": 1, "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The styleListingId for curation rate schedule." }, "curationRateTypeCode": { "pattern": "^[_A-Z0-9]{1,100}$", "type": "string", "description": "The curationRateTypeCode for curation rate schedule." }, "curationRateCode": { "pattern": "^[_A-Z0-9]{1,100}$", "type": "string", "description": "The curationRateCode for curation rate schedule." } }, "description": "A curation rate schedule to create", "xml": { "name": "CreateCurationRateSchedule" } }, "PartnerCurationRateScheduleService_CreateCurationRateScheduleRequest": { "required": [ "createCurationRateSchedules" ], "type": "object", "properties": { "createCurationRateSchedules": { "maxItems": 1000, "minItems": 1, "type": "array", "description": "The curation rate schedule to create", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CreateCurationRateSchedule" } } }, "xml": { "name": "createCurationRateScheduleRequest" } }, "PartnerCurationRateScheduleService_DeleteCurationRateScheduleResult": { "type": "object", "properties": { "echoId": { "type": "string", "description": "A unique surrogate-key (string) used for each request list element so you are able to absolutely identitify the corresponding response list elements just in case the list order is not maintained during the API request." }, "styleRateScheduleId": { "type": "string", "description": "The styleRateScheduleId for the curation rate schedule." }, "errorCode": { "type": "string", "description": "The errorCode for the curation rate schedule." }, "errorMessage": { "type": "string", "description": "The errorMessage for the curation rate schedule." }, "resultStatus": { "type": "string", "description": "The status for the delete curation rate schedule request." } }, "description": "A delete curation rate schedule result", "xml": { "name": "DeleteCurationRateScheduleResult" } }, "PartnerCurationRateScheduleService_DeletePartnerCurationRateScheduleResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deleteCurationRateScheduleResults": { "type": "array", "description": "List of requested deleted curation rate schedule IDs with results", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_DeleteCurationRateScheduleResult" } } }, "xml": { "name": "deleteCurationRateScheduleResponse" } }, "PartnerCurationRateScheduleService_DeleteCurationRateSchedule": { "required": [ "styleRateScheduleId" ], "type": "object", "properties": { "echoId": { "maxLength": 100, "minLength": 0, "type": "string", "description": "A unique surrogate-key (string) used for each request list element so you are able to absolutely identitify the corresponding response list elements just in case the list order is not maintained during the API request.", "example": "A unique surrogate-key (string) used for each request list element so you are able to absolutely identitify the corresponding response list elements just in case the list order is not maintained during the API request." }, "styleRateScheduleId": { "type": "string", "description": "The styleRateScheduleId for curation rate schedule." } }, "description": "A curation rate schedule to delete", "xml": { "name": "DeleteCurationRateSchedule" } }, "PartnerCurationRateScheduleService_DeleteCurationRateScheduleRequest": { "required": [ "deleteCurationRateSchedules" ], "type": "object", "properties": { "deleteCurationRateSchedules": { "type": "array", "description": "The curation rate schedule to delete", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_DeleteCurationRateSchedule" } } }, "xml": { "name": "deleteCurationRateScheduleRequest" } }, "PartnerCurationRateScheduleService_CurationRate": { "type": "object", "properties": { "dateTime": { "type": "string", "description": "The dateTime.", "format": "date-time" }, "userAccountId": { "type": "string", "description": "The userAccountId." }, "username": { "type": "string", "description": "The username." }, "firstName": { "type": "string", "description": "The firstName." }, "lastName": { "type": "string", "description": "The lastName." } }, "description": "A curation rate for a curation rate schedule result", "xml": { "name": "CurationRate" } }, "PartnerCurationRateScheduleService_CurationRateMethod": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the curation rate schedule." }, "name": { "type": "string", "description": "The name for the curation rate schedule." }, "description": { "type": "string", "description": "The description for the curation rate schedule." } }, "description": "A curation rate method for a curation rate", "xml": { "name": "CurationRateMethod" } }, "PartnerCurationRateScheduleService_CurationRateType": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the curation rate schedule." }, "name": { "type": "string", "description": "The name for the curation rate schedule." }, "description": { "type": "string", "description": "The description for the curation rate schedule." } }, "description": "A curation rate type for a curation rate", "xml": { "name": "CurationRateType" } }, "PartnerCurationRateScheduleService_GetCurationRateScheduleDetailResult": { "type": "object", "properties": { "styleRateScheduleId": { "type": "string", "description": "The styleRateScheduleId for the curation rate schedule." }, "styleListingId": { "type": "string", "description": "The styleListingId for the curation rate schedule." }, "styleNumber": { "type": "string", "description": "The styleNumber for the curation rate schedule." }, "curationRateType": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CurationRateType" }, "curationRate": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CurationRate" }, "endTimestamp": { "type": "string", "description": "The endTimestamp for the curation rate schedule.", "format": "date-time" }, "startTimestamp": { "type": "string", "description": "The startTimestamp for the curation rate schedule.", "format": "date-time" }, "createdInfo": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_CurationRate" }, "lastUpdatedInfo": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_LastUpdatedInfo" } }, "description": "A curation rate schedule detail result for get", "xml": { "name": "GetCurationRateScheduleDetailResult" } }, "PartnerCurationRateScheduleService_GetCurationRateSchedulesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "filteredListCount": { "type": "integer", "description": "Total Count of Curation Rate Schedules matching Query Parameters (count with filtering)", "format": "int64" }, "totalListCount": { "type": "integer", "description": "Total Count of Curation Rate Schedules", "format": "int64" }, "getCurationRateSchedulesResults": { "type": "array", "description": "The list of curation rate schedules matching the filter query parameters", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCurationRateScheduleService_GetCurationRateScheduleDetailResult" } } }, "xml": { "name": "getCurationRateSchedulesResponse" } }, "PartnerCurationRateScheduleService_LastUpdatedInfo": { "type": "object", "properties": { "dateTime": { "type": "string", "description": "The dateTime.", "format": "date-time" }, "userAccountId": { "type": "string", "description": "The userAccountId." }, "username": { "type": "string", "description": "The username." }, "firstName": { "type": "string", "description": "The firstName." }, "lastName": { "type": "string", "description": "The lastName." } }, "description": "A last updated info for a curation rate schedule result", "xml": { "name": "LastUpdatedInfo" } }, "PartnerCustomerOrderService_GetCustomerOrderDetailResponse": { "required": [ "partnerCustomerOrder" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerCustomerOrder": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrder" } }, "xml": { "name": "partnerCustomerOrderDetailResponse" } }, "PartnerCustomerOrderService_PartnerCustomerOrder": { "required": [ "customerInformation", "orderDetails", "orderInformation", "orderNumber", "orderType", "shippingInformation" ], "type": "object", "properties": { "orderNumber": { "type": "integer", "description": "Partner Customer Order Number", "format": "int64", "example": 8675309 }, "orderType": { "type": "string", "description": "Order Type", "example": "O" }, "orderInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderInformation" }, "customerInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderCustomerInformation" }, "shippingInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderShippingInformation" }, "orderDetails": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderDetails" }, "returnSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderReturnSummary" } }, "description": "A Partner Customer Order", "xml": { "name": "partnerCustomerOrder" } }, "PartnerCustomerOrderService_PartnerCustomerOrderCustomerInformation": { "required": [ "customerFirstName" ], "type": "object", "properties": { "customerFirstName": { "type": "string", "description": "Customer First Name", "example": "Reginald" } }, "description": "Customer Information", "xml": { "name": "customerInformation" } }, "PartnerCustomerOrderService_PartnerCustomerOrderDetails": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Order Details", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderItem" } } }, "description": "Order Details", "xml": { "name": "orderDetails" } }, "PartnerCustomerOrderService_PartnerCustomerOrderInformation": { "required": [ "itemCount", "orderNumber", "orderStatus", "orderTotal", "shipToCity", "shipToState" ], "type": "object", "properties": { "orderNumber": { "type": "integer", "description": "Partner Customer Order Number", "format": "int64", "example": 8675309 }, "itemCount": { "type": "integer", "description": "Item Count", "format": "int32", "example": 1 }, "orderStatus": { "type": "string", "description": "Order Status", "example": "S" }, "orderDateTime": { "type": "string", "description": "Order Date Time", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "orderTotal": { "type": "number", "description": "Order Total", "example": 100.0 }, "shipToCity": { "type": "string", "description": "Ship to City", "example": "Boston" }, "shipToState": { "type": "string", "description": "Ship to State", "example": "MA" } }, "description": "Partner Customer Order Information", "xml": { "name": "orderInformation" } }, "PartnerCustomerOrderService_PartnerCustomerOrderItem": { "required": [ "itemPrice", "quantityOrdered", "skuNumber", "styleImage", "styleNumber", "styleTitleDescription" ], "type": "object", "properties": { "styleNumber": { "type": "string", "description": "Style Number", "example": "12345-4" }, "styleImage": { "type": "string", "description": "Style Image", "example": "/path/to/image/1234.png" }, "styleTitleDescription": { "type": "string", "description": "Style Title Desc", "example": "World Series Ring" }, "itemSize": { "type": "string", "description": "Item Size", "example": "XL" }, "skuNumber": { "type": "string", "description": "SKU Number", "example": "12345" }, "supplierStyleNumber": { "type": "string", "description": "Supplier Style Number", "example": "12345" }, "supplierSkuNumber": { "type": "string", "description": "Supplier SKU Number", "example": "12345" }, "quantityOrdered": { "type": "integer", "description": "Quantity Ordered", "format": "int32", "example": 1 }, "quantityReturned": { "type": "integer", "description": "Quantity Returned", "format": "int32", "example": 0 }, "itemPrice": { "type": "number", "description": "Item Price", "example": 99.99 }, "returnCredit": { "type": "number", "description": "Return Credit", "example": 99.99 } }, "description": "Order Details", "xml": { "name": "item" } }, "PartnerCustomerOrderService_PartnerCustomerOrderReturnSummary": { "required": [ "returnTotal" ], "type": "object", "properties": { "returnCredit": { "type": "number", "description": "Return Credit", "example": 100.0 }, "serviceFee": { "type": "number", "description": "Service Fee", "example": 1.0 }, "returnTotal": { "type": "number", "description": "Return Total", "example": 100.0 }, "paymentMethod": { "type": "string", "description": "Payment Method", "example": "paymentMethod" } }, "description": "Return Summary", "xml": { "name": "returnSummary" } }, "PartnerCustomerOrderService_PartnerCustomerOrderShipTo": { "required": [ "addressLine1", "country", "postalCode", "shipToCity", "shipToName", "shipToState" ], "type": "object", "properties": { "shipToCity": { "type": "string", "description": "Ship to City", "example": "Boston" }, "shipToState": { "type": "string", "description": "Ship to State", "example": "MA" }, "shipToName": { "type": "string", "description": "Ship to Name", "example": "Reginald" }, "addressLine1": { "type": "string", "description": "Address Line 1", "example": "4 Jersey Street" }, "addressLine2": { "type": "string", "description": "Address Line 2", "example": "Suite A" }, "postalCode": { "type": "string", "description": "Postal Code", "example": "02215" }, "country": { "type": "string", "description": "Country", "example": "US" } }, "description": "ShipTo Information", "xml": { "name": "shipTo" } }, "PartnerCustomerOrderService_PartnerCustomerOrderShippingInformation": { "required": [ "shipTo" ], "type": "object", "properties": { "estimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date Time", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "shippingService": { "type": "string", "description": "Shipping Service", "example": "UPS" }, "shipTo": { "$ref": "#/components/schemas/PartnerCustomerOrderService_PartnerCustomerOrderShipTo" } }, "description": "Shipping Information", "xml": { "name": "shippingInformation" } }, "JtvApiResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } } }, "PartnerFulfillmentPackageService_CancelSalesOrderReasonCodeRequest": { "required": [ "cancelReasonCode" ], "type": "object", "properties": { "cancelReasonCode": { "type": "string", "description": "The reason code for order cancellation" } }, "xml": { "name": "cancelSalesOrderReasonCodeRequest" } }, "PartnerCustomerOrderService_GetPartnerCustomerOrderLinesResponse": { "required": [ "orderHeaderId", "orderLines" ], "type": "object", "properties": { "orderHeaderId": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderLines": { "type": "array", "description": "Customer Sales Order Lines.", "xml": { "name": "customerOrderLines", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderLine" } }, "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "partnerCustomerOrderLinesResponse" } }, "PartnerCustomerOrderService_LineDiscount": { "type": "object", "properties": { "lineDiscountSkuNumber": { "type": "string", "description": "The SKU number of the discount item" }, "lineDiscountCode": { "type": "string", "description": "The discount code" }, "lineDiscountDescription": { "type": "string", "description": "The discount description" }, "lineDiscountQuantity": { "type": "integer", "description": "The quantity eligible for discount", "format": "int32" }, "lineDiscountOfferType": { "type": "string", "description": "The discount offer type" }, "lineDiscountPrice": { "type": "number", "description": "The discount price", "format": "float" } }, "description": "The list of service discount", "xml": { "name": "lineDiscount" } }, "PartnerCustomerOrderService_OrderHeaderOrderStatus": { "required": [ "orderStatusCode", "orderStatusDescription", "orderStatusName" ], "type": "object", "properties": { "orderStatusCode": { "type": "string", "description": "Order Status Code" }, "orderStatusName": { "type": "string", "description": "Order Status Name" }, "orderStatusDescription": { "type": "string", "description": "Order Status Description" } }, "description": "The order line status", "xml": { "name": "OrderStatus" } }, "PartnerCustomerOrderService_OrderLine": { "type": "object", "properties": { "orderLineId": { "type": "string", "description": "The order line unique identifier" }, "orderLineNumber": { "type": "string", "description": "The order line number", "example": "162494230" }, "orderLinePosition": { "type": "string", "description": "The order line rank number" }, "originalOrderInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OriginalOrder" }, "receiptLineId": { "type": "string", "description": "Return order receipt header unique identifier" }, "orderLineStatus": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderOrderStatus" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date", "format": "date-time" }, "orderDateTime": { "type": "string", "description": "The order date time", "format": "date-time" }, "orderProcessDateTime": { "type": "string", "description": "The order process date time", "format": "date-time" }, "productInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ProductInformation" }, "orderLineQuantity": { "type": "integer", "description": "The ordered quantity", "format": "int32" }, "orderLineTotalAmount": { "type": "number", "description": "The order line total amount", "format": "float" }, "orderLineSummaryInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderLineSummaryInformation" }, "serviceLines": { "type": "array", "description": "The list of service charges", "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ServiceLine" } } }, "description": "Customer Sales Order Lines.", "xml": { "name": "orderLine" } }, "PartnerCustomerOrderService_OrderLineSummaryInformation": { "type": "object", "properties": { "orderSubTotalValue": { "type": "number", "description": "The order line subtotal amount", "format": "float" }, "orderLineTotal": { "type": "number", "description": "The order line total charges excluding tax", "format": "float" }, "orderLineGrandTotal": { "type": "number", "description": "The grand total amount", "format": "float" }, "productSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ProductSummary" }, "serviceSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ServiceItemSummary" }, "shippingSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ShippingSummary" } }, "description": "The order line summary information", "xml": { "name": "orderLineSummaryInformation" } }, "PartnerCustomerOrderService_OriginalOrder": { "required": [ "orderHeaderId", "orderNumber" ], "type": "object", "properties": { "orderHeaderId": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderNumber": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderLineId": { "type": "string", "description": "Partner Customer Order Line Number", "example": "8675309" }, "orderLineNumber": { "type": "string", "description": "Partner Customer Order Line Number", "example": "8675309" } }, "description": "Return Order's Original Order Information", "xml": { "name": "OriginalOrderInformation" } }, "PartnerCustomerOrderService_ProductInformation": { "type": "object", "properties": { "skuNumber": { "type": "string", "description": "The product sku number" }, "skuSize": { "type": "string", "description": "The product size" }, "supplierSkuNumber": { "type": "string", "description": "The supplier sku number" }, "productNumber": { "type": "string", "description": "The product number" }, "styleNumber": { "type": "string", "description": "The style number" }, "styleTitleDescription": { "type": "string", "description": "The style description" }, "styleImageUrl": { "type": "string", "description": "The style image URL" }, "basePrice": { "type": "number", "description": "The product base price", "format": "float" } }, "description": "The order line product information", "xml": { "name": "productInformation" } }, "PartnerCustomerOrderService_ProductSummary": { "type": "object", "properties": { "orderLineProductGrandTotal": { "type": "number", "description": "The product grand total", "format": "float" }, "orderLineProductSubtotal": { "type": "number", "description": "The product subtotal (quantity x price)", "format": "float" }, "orderLineProductDiscounts": { "type": "number", "description": "The discount on product charges", "format": "float" }, "orderLineProductTotal": { "type": "number", "description": "The total product charges excluding tax", "format": "float" }, "orderLineProductTax": { "type": "number", "description": "The tax amount on product charges", "format": "float" } }, "description": "Order line product summary", "xml": { "name": "productSummary" } }, "PartnerCustomerOrderService_ServiceItemSummary": { "type": "object", "properties": { "orderLineServiceSubtotal": { "type": "number", "description": "The service charges", "format": "float" }, "orderLineServiceDiscounts": { "type": "number", "description": "The discount on service charges", "format": "float" }, "orderLineServiceTotal": { "type": "number", "description": "The total service charges excluding tax", "format": "float" }, "orderLineServiceTax": { "type": "number", "description": "The tax amount on service charges", "format": "float" }, "orderLineServiceGrandTotal": { "type": "number", "description": "The total service charges", "format": "float" } }, "description": "Order line service item summary", "xml": { "name": "serviceItemSummary" } }, "PartnerCustomerOrderService_ServiceLine": { "type": "object", "properties": { "serviceLineNumber": { "type": "string", "description": "The service line number" }, "serviceTypeCode": { "type": "string", "description": "The service type code" }, "serviceTypeName": { "type": "string", "description": "The service type name" }, "serviceTypeDescription": { "type": "string", "description": "The service type description" }, "serviceTotalAmount": { "type": "number", "description": "The service charge", "format": "float" }, "serviceLineDiscounts": { "type": "array", "description": "The list of service discount", "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_LineDiscount" } } }, "description": "The list of service charges", "xml": { "name": "serviceLine" } }, "PartnerCustomerOrderService_ShippingSummary": { "type": "object", "properties": { "orderLineShippingSubtotal": { "type": "number", "description": "The shipping's subtotal.", "format": "float" }, "orderLineShippingDiscounts": { "type": "number", "description": "The shipping's discounts.", "format": "float" }, "orderLineShippingTotal": { "type": "number", "description": "The shipping's total.", "format": "float" }, "orderLineShippingTax": { "type": "number", "description": "The shipping's tax.", "format": "float" }, "orderLineShippingGrandTotal": { "type": "number", "description": "The shipping's grand total.", "format": "float" } }, "description": "Order line shipping summary", "xml": { "name": "shippingSummary" } }, "PartnerCustomerOrderService_FetchOrderHeaderResponse": { "required": [ "orderHeaderInformation" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderHeaderInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderInformation" } }, "xml": { "name": "fetchOrderHeaderResponse" } }, "PartnerCustomerOrderService_OrderHeaderCustomerInformation": { "required": [ "customerFirstName", "customerId", "customerLastName" ], "type": "object", "properties": { "customerId": { "type": "string", "description": "The customer's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "customerFirstName": { "type": "string", "description": "Customer First Name" }, "customerLastName": { "type": "string", "description": "Customer Last Name" } }, "description": "Customer Information", "xml": { "name": "customerInformation" } }, "PartnerCustomerOrderService_OrderHeaderDateInformation": { "required": [ "minDeliveryDate", "minEstimatedDeliveryDate", "minExpectedDeliveryDate", "minOrderDateTime", "minShipDate" ], "type": "object", "properties": { "minOrderDateTime": { "type": "string", "description": "Minimum order date across order lines", "format": "date-time" }, "minExpectedDeliveryDate": { "type": "string", "description": "Minimum expected delivery date across order lines", "format": "date-time" }, "minShipDate": { "type": "string", "description": "Minimum ship date across order lines", "format": "date-time" }, "minEstimatedDeliveryDate": { "type": "string", "description": "Minimum estimated delivery date across order lines", "format": "date-time" }, "minDeliveryDate": { "type": "string", "description": "Minimum delivery date across order lines", "format": "date-time" }, "minOrderProcessDateTime": { "type": "string", "description": "Minimum process date across order lines", "format": "date-time" } }, "description": "Order Dates Information", "xml": { "name": "DateInformation" } }, "PartnerCustomerOrderService_OrderHeaderInformation": { "required": [ "orderHeaderId", "orderNumber", "orderTotalLineCount", "orderTotalLineQuantity" ], "type": "object", "properties": { "orderHeaderId": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderNumber": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "originalOrderInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OriginalOrder" }, "orderTotalLineCount": { "type": "integer", "description": "Order Total Line Count", "format": "int32" }, "orderTotalLineQuantity": { "type": "integer", "description": "Order Total Quantity", "format": "int32" }, "orderPaymentMethodType": { "type": "string", "description": "Order Payment Method Type", "example": "CC" }, "orderedDeliveryService": { "type": "string", "description": "Order Delivery Service Name", "example": "Next Day Service" }, "orderStatus": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderOrderStatus" }, "customerInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderCustomerInformation" }, "shipToInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderShipToInformation" }, "orderSummaryInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderOrderSummaryInformation" }, "dateInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderDateInformation" } }, "description": "A Partner Customer Sales Order Header", "xml": { "name": "orderHeaderInformation" } }, "PartnerCustomerOrderService_OrderHeaderOrderSummaryInformation": { "required": [ "orderGrandTotal", "orderTax", "orderTotal", "productSummary", "serviceSummary", "shippingSummary" ], "type": "object", "properties": { "productSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ProductSummary" }, "serviceSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ServiceItemSummary" }, "shippingSummary": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ShippingSummary" }, "orderGrandTotal": { "type": "number", "description": "Order Grand Total", "format": "float" }, "orderTotal": { "type": "number", "description": "Order Total", "format": "float" }, "orderTax": { "type": "number", "description": "Order Tax", "format": "float" } }, "description": "Order Summary Information", "xml": { "name": "OrderSummaryInformation" } }, "PartnerCustomerOrderService_OrderHeaderShipToInformation": { "required": [ "shipAddressId", "shipFirstName", "shipLastName" ], "type": "object", "properties": { "shipAddressId": { "type": "string", "description": "The address's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipFirstName": { "type": "string", "description": "Ship-To First Name" }, "shipLastName": { "type": "string", "description": "Ship-To Last Name" } }, "description": "Ship-To Information", "xml": { "name": "ShipToInformation" } }, "PartnerCustomerOrderService_ConsumerFinancing": { "type": "object", "properties": { "financingProductName": { "type": "string", "description": "The financing product name", "example": "StretchPay 5-Pay" }, "financingTermsCode": { "type": "string", "description": "The financing term code", "example": "5_30_0" }, "financingTermsName": { "type": "string", "description": "The financing term name", "example": "5 Pay" }, "financingFirstInstallmentAmount": { "type": "number", "description": "The first installment amount", "format": "float" }, "financingSubsequentInstallmentAmount": { "type": "number", "description": "The next scheduled installment amount", "format": "float" }, "financingPlanTotal": { "type": "number", "description": "The financing amount", "format": "float" } }, "description": "The financing information", "xml": { "name": "consumerFinancing" } }, "PartnerCustomerOrderService_FetchOrderLineDetailsResponse": { "required": [ "orderLineDetails" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderLineDetails": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderLineDetails" } }, "xml": { "name": "fetchOrderLineDetailsResponse" } }, "PartnerCustomerOrderService_OrderLineDetails": { "type": "object", "properties": { "orderLineId": { "type": "string", "description": "The order line unique identifier" }, "orderLineNumber": { "type": "string", "description": "The order line number", "example": "162494230" }, "orderLinePosition": { "type": "string", "description": "The order line rank number" }, "originalOrderInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OriginalOrder" }, "receiptLineId": { "type": "string", "description": "Return order receipt header unique identifier" }, "orderLineStatus": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderHeaderOrderStatus" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date", "format": "date-time" }, "orderDateTime": { "type": "string", "description": "The order date time", "format": "date-time" }, "orderProcessDateTime": { "type": "string", "description": "The order process date time", "format": "date-time" }, "productInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ProductInformation" }, "orderLineQuantity": { "type": "integer", "description": "The ordered quantity", "format": "int32" }, "orderLineSummaryInformation": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderLineSummaryInformation" }, "serviceLines": { "type": "array", "description": "The list of service charges", "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ServiceLine" } }, "orderHeaderId": { "type": "string", "description": "The order header unique identifier", "example": "162494230" }, "expectedDeliveryDateGuarantee": { "type": "boolean", "description": "Indicate expected delivery data is a guaranteed date" }, "expectedDeliveryDate": { "type": "string", "description": "The expected delivery date", "format": "date-time" }, "orderLineProductPrice": { "type": "number", "description": "The product price", "format": "float" }, "orderLineDiscounts": { "type": "array", "description": "The list of discounts applied to the product", "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderLineDiscount" } }, "consumerFinancing": { "$ref": "#/components/schemas/PartnerCustomerOrderService_ConsumerFinancing" }, "transactions": { "type": "array", "description": "The list of transactions", "items": { "$ref": "#/components/schemas/PartnerCustomerOrderService_OrderLineTransaction" } } }, "description": "A Partner Customer Sales Order Line", "xml": { "name": "orderLineDetails" } }, "PartnerCustomerOrderService_OrderLineDiscount": { "type": "object", "properties": { "lineDiscountSkuNumber": { "type": "string", "description": "The SKU number of the discount item" }, "lineDiscountCode": { "type": "string", "description": "The discount code" }, "lineDiscountDescription": { "type": "string", "description": "The discount description" }, "lineDiscountQuantity": { "type": "integer", "description": "The quantity eligible for discount", "format": "int32" }, "lineDiscountOfferType": { "type": "string", "description": "The discount offer type" }, "lineDiscountPrice": { "type": "number", "description": "The discount price", "format": "float" }, "lineDiscountTotal": { "type": "number", "description": "The total discount", "format": "float" } }, "description": "The list of discounts applied to the product", "xml": { "name": "OrderLineDiscount" } }, "PartnerCustomerOrderService_OrderLineTransaction": { "required": [ "transactionId" ], "type": "object", "properties": { "transactionId": { "type": "string", "description": "The transaction's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "transactionDateTime": { "type": "string", "description": "The transaction's date.", "format": "date-time" }, "transactionPostedDateTime": { "type": "string", "description": "The transaction's posted date.", "format": "date-time" }, "transactionStatus": { "type": "string", "description": "The transaction's status." }, "transactionTitle": { "type": "string", "description": "The transaction's title." }, "transactionCategory": { "type": "string", "description": "The transaction's category." }, "transactionSubCategory": { "type": "string", "description": "The transaction's subcategory." }, "transactionType": { "type": "string", "description": "The transaction's type." }, "transactionAmount": { "type": "number", "description": "The transaction's amount.", "format": "float" }, "jtvStyleImageUrl": { "type": "string", "description": "The JTV image URL." } }, "description": "The list of transactions", "xml": { "name": "orderLineTransaction" } }, "PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderHeaderResponse": { "required": [ "deliveryServiceOrderHeaderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderHeaderUuid": { "type": "string", "description": "The unique code representing an existing delivery service order header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerDeliveryServiceOrderHeaderResponse" } }, "PartnerDeliveryServiceOrderService_CreatePartnerFulfillmentShipmentHeaderRequest": { "required": [ "shipmentBatchHeaderId" ], "type": "object", "properties": { "shipmentBatchHeaderId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The shipment batch header's unique universal identifier." } }, "xml": { "name": "createPartnerFulfillmentShipmentHeaderRequest" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderHeaderSummary": { "type": "object", "properties": { "deliveryServiceOrderHeaderId": { "type": "string", "description": "The unique code representing an delivery service order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentBatchHeaderId": { "type": "string", "description": "The unique code representing a shipment batch header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "lastUpdatedUserId": { "type": "integer", "description": "The identifier for the last user to update this delivery service order.", "format": "int64", "example": 12312 }, "deliveryServiceOrderHeaderNumber": { "type": "string", "description": "The unique delivery order number.", "example": "PSC69G09278S" }, "deliveryServiceOrderHeaderOrderDateTime": { "type": "string", "description": "The delivery service order's date and time.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deliveryServiceOrderStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderStatus" }, "deliveryServiceOrderSummaryInfo": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderSummaryInfo" } }, "description": "A delivery service order.", "xml": { "name": "deliveryServiceOrderHeaderSummary" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The short name for the order status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description of the order status.", "example": "The order is currently being designed and is pending completion." } }, "description": "A delivery service order's status.", "xml": { "name": "deliveryServiceOrderStatus" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderSummaryInfo": { "required": [ "orderLineCount", "orderTotal", "packageHeaderCount", "shipmentGroupHeaderCount", "shipmentHeaderCount" ], "type": "object", "properties": { "orderTotal": { "type": "number", "description": "The order total", "example": 13.02 }, "shipmentGroupHeaderCount": { "type": "integer", "description": "The number of shipment group headers for this delivery service order", "format": "int32", "example": 12 }, "shipmentHeaderCount": { "type": "integer", "description": "The number of shipment group headers for this delivery service order", "format": "int32", "example": 16 }, "packageHeaderCount": { "type": "integer", "description": "The number of package headers for this delivery service order", "format": "int32", "example": 5 }, "orderLineCount": { "type": "integer", "description": "The number of order lines for this delivery service order", "format": "int32", "example": 5 } }, "description": "A delivery service order's overall summary information.", "xml": { "name": "deliveryServiceOrderSummaryInfo" } }, "PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderHeadersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "numberOfDeliveryServiceOrderHeaders": { "type": "integer", "description": "The number of delivery service orders that satisfy the filter criteria.", "format": "int32", "example": 5 }, "deliveryServiceOrders": { "type": "array", "description": "The paged list of delivery service orders that satisfy the filter criteria.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderHeaderSummary" } } }, "xml": { "name": "getPartnerDeliveryServiceOrderHeadersResponse" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderFeeSummary": { "required": [ "additionalServicesFee", "basePostageFee", "totalFee" ], "type": "object", "properties": { "basePostageFee": { "type": "number", "description": "Base Postage Fee", "example": 13.02 }, "additionalServicesFee": { "type": "number", "description": "Additional Services Fee", "example": 13.02 }, "totalFee": { "type": "number", "description": "Total Fee", "example": 13.02 } }, "description": "A delivery service order's fee summary information.", "xml": { "name": "deliveryServiceOrderFeeSummary" } }, "PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderHeaderDetailResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderHeaderId": { "type": "string", "description": "The unique code representing an delivery service order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderFeeSummary": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderFeeSummary" }, "deliveryServiceOrderNumber": { "type": "string", "description": "The alphanumeric batch number representing a delivery service order.", "example": "DSDVMB7CC4N2" }, "shipmentBatchHeaderId": { "type": "string", "description": "The unique code representing a shipment batch header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentBatchNumber": { "type": "string", "description": "The alphanumeric batch number representing a shipment batch header.", "example": "SB5TL78VJ2HT" }, "deliveryServiceOrderHeaderOrderDateTime": { "type": "string", "description": "The delivery service order's date and time.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deliveryServiceOrderStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderStatus" }, "lastUpdatedUserUuid": { "type": "string", "description": "The identifier for the last user to update this delivery service order." }, "createdUserUuid": { "type": "string", "description": "The identifier for the created user." }, "deliveryServiceOrderSummaryInfo": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderSummaryInfo" }, "shipmentGroupHeaders": { "type": "array", "description": "Summary information for the order.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentGroupHeader" } } }, "xml": { "name": "getPartnerDeliveryServiceOrderHeaderDetailResponse" } }, "PartnerDeliveryServiceOrderService_ShipmentGroupHeader": { "required": [ "shipmentGroupHeaderId", "shipmentGroupHeaderStatus", "shipmentGroupNumber" ], "type": "object", "properties": { "shipmentGroupHeaderId": { "type": "string", "description": "The unique code representing a shipment group header", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentGroupNumber": { "type": "string", "description": "The alphanumeric batch number representing a shipment group header.", "example": "SG06BOOKU4J" }, "shipmentGroupHeaderStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentGroupHeaderStatus" } }, "description": "A delivery service order's shipment group header information.", "xml": { "name": "shipmentGroupHeader" } }, "PartnerDeliveryServiceOrderService_ShipmentGroupHeaderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment group header's status.", "example": "READY_TO_PICK" }, "name": { "type": "string", "description": "The short name for the shipment group header's status.", "example": "Ready to Pick" }, "description": { "type": "string", "description": "The description of the shipment group header's status.", "example": "The shipment group has been created and is ready to pick the SKUs needed to fulfill the associated shipments." } }, "description": "A shipment group header's status.", "xml": { "name": "shipmentGroupHeaderStatus" } }, "PartnerDeliveryServiceOrderService_DeletePartnerDeliveryServiceOrderHeaderResponse": { "required": [ "deliveryServiceOrderHeaderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderHeaderUuid": { "type": "string", "description": "The unique code representing the deleted delivery service order header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "deletePartnerDeliveryServiceOrderHeaderResponse" } }, "PartnerDeliveryServiceOrderService_DeletePartnerDeliveryServiceOrderLineResponse": { "required": [ "deliveryServiceOrderLineUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderLineUuid": { "type": "string", "description": "The unique code representing the deleted delivery service order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "deletePartnerDeliveryServiceOrderLineResponse" } }, "PartnerDeliveryServiceOrderService_AdditionalService": { "required": [ "code", "description", "name", "serviceFee" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the additional service.", "example": "USPS_PRIORITY_MAIL_EXPRESS_SIGNATURE_CONFIRMATION_ELECTRONIC" }, "name": { "type": "string", "description": "The short name for the additional service.", "example": "Priority Mail Express Signature Confirmation Electronic" }, "description": { "type": "string", "description": "The description of the additional service.", "example": "USPS Priority Mail Express Signature Confirmation Electronic" }, "serviceFee": { "type": "number", "description": "The service fee for the additional service.", "example": 13.42 } }, "description": "A delivery service order line's additional service information.", "xml": { "name": "additionalService" } }, "PartnerDeliveryServiceOrderService_Carrier": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the carrier.", "example": "USPS" }, "name": { "type": "string", "description": "The short name for the carrier.", "example": "United States Postal Service (USPS)" }, "description": { "type": "string", "description": "The description of the carrier.", "example": "United States Postal Service" } }, "description": "Carrier information.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "carrier" } }, "PartnerDeliveryServiceOrderService_DeliveryService": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_Carrier" }, "service": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_Service" }, "averageTransitTime": { "type": "string", "description": "Information regarding the delivery date" }, "postageFee": { "type": "number", "description": "The postage fee." }, "packageLabelId": { "type": "string", "description": "The unique code representing a package label id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "trackingNumber": { "type": "string", "description": "The tracking number.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "additionalServiceList": { "type": "array", "description": "List of additional services for the delivery service.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_AdditionalService" } } }, "description": "Information regarding the delivery service.", "xml": { "name": "deliveryService" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceFees": { "required": [ "additionalServicesFees", "postageFees", "totalFees" ], "type": "object", "properties": { "postageFees": { "type": "number", "description": "The postage fees for the delivery service.", "example": 13.42 }, "additionalServicesFees": { "type": "number", "description": "The additional services fees for the delivery service.", "example": 13.42 }, "totalFees": { "type": "number", "description": "The total fees for the delivery service.", "example": 26.84 }, "currencyCode": { "type": "string", "description": "The service currency code.", "example": "USD" } }, "description": "The information regarding the delivery service fees.", "xml": { "name": "deliveryServiceFees" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineCarrierError": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "The carrier error code." }, "errorName": { "type": "string", "description": "The carrier error name." }, "errorDescription": { "type": "string", "description": "The carrier error description." }, "carrierCode": { "type": "string", "description": "The carrier code." }, "carrierName": { "type": "string", "description": "The carrier name." } }, "description": "Carrier error information.", "xml": { "name": "DeliveryServiceOrderLineCarrierError" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineError": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code." }, "description": { "type": "string", "description": "The error message." }, "deliveryServiceOrderLineCarrierError": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineCarrierError" } }, "description": "A delivery service order line error.", "xml": { "name": "deliveryServiceOrderLineError" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The short name for the order status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description of the order status.", "example": "The order is currently being designed and is pending completion." } }, "description": "A delivery service order line's status.", "xml": { "name": "deliveryServiceOrderLineStatus" } }, "PartnerDeliveryServiceOrderService_GetDeliveryServiceOrderLineDetailResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderLineId": { "type": "string", "description": "The unique code representing an delivery service order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderHeaderId": { "type": "string", "description": "The unique code representing an delivery service order header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderLineNumber": { "type": "string", "description": "The alphanumeric number representing a delivery service order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderLineStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineStatus" }, "deliveryService": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryService" }, "deliveryServiceFees": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceFees" }, "packageHeaderInfo": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageHeaderInfo" }, "deliveryServiceOrderLineError": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineError" }, "deliveryServiceOrderLinePrintDate": { "type": "string", "description": "The time that the delivery service order line was created", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deliveryServiceOrderLineOrderDate": { "type": "string", "description": "The time that the delivery service order line was ordered", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "getDeliveryServiceOrderLineDetailResponse" } }, "PartnerDeliveryServiceOrderService_OrderedDeliveryService": { "type": "object", "properties": { "orderedDeliveryServiceCode": { "type": "string", "description": "The ordered delivery service's code." }, "orderedDeliveryServiceName": { "type": "string", "description": "The ordered delivery service's name." } }, "description": "A shipment's ordered delivery service information.", "xml": { "name": "orderedDeliveryService" } }, "PartnerDeliveryServiceOrderService_PackageDimensions": { "required": [ "height", "length", "packageDimensionsUnitOfMeasure", "width" ], "type": "object", "properties": { "length": { "type": "number", "description": "The package length dimension.", "format": "double", "example": 12 }, "width": { "type": "number", "description": "The package length dimension.", "format": "double", "example": 13 }, "height": { "type": "number", "description": "The package height dimension.", "format": "double", "example": 7 }, "packageDimensionsUnitOfMeasure": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UnitOfMeasure" } }, "description": "Package dimension information.", "xml": { "name": "packageDimensions" } }, "PartnerDeliveryServiceOrderService_PackageHeaderInfo": { "type": "object", "properties": { "packageHeaderId": { "type": "string", "description": "The unique code representing a package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageNumber": { "type": "string", "description": "The alphanumeric number representing a package number.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageName": { "type": "string", "description": "The name given to a package.", "example": "Package 1" }, "packageStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageStatus" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageWeight" }, "shipmentHeaderInfo": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentHeaderInfo" } }, "description": "A delivery service order line's package header info.", "xml": { "name": "packageHeaderInfo" } }, "PartnerDeliveryServiceOrderService_PackageStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The short name for the order status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description of the order status.", "example": "The order is currently being designed and is pending completion." } }, "description": "A package header's status.", "xml": { "name": "packageStatus" } }, "PartnerDeliveryServiceOrderService_PackageWeight": { "required": [ "packageWeight", "packageWeightUnitOfMeasure" ], "type": "object", "properties": { "packageWeight": { "type": "number", "description": "The weight of the package.", "format": "double", "example": 13.3 }, "packageWeightUnitOfMeasure": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_UnitOfMeasure" } }, "description": "Package weight information.", "xml": { "name": "packageWeight" } }, "PartnerDeliveryServiceOrderService_Service": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the service.", "example": "USPS_FIRST_CLASS_MAIL" }, "name": { "type": "string", "description": "The short name for the service.", "example": "USPS First Class Mail" }, "description": { "type": "string", "description": "The description of the service.", "example": "USPS First Class Mail" } }, "description": "Information regarding the service.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "service" } }, "PartnerDeliveryServiceOrderService_ShipmentHeaderInfo": { "type": "object", "properties": { "shipmentHeaderId": { "type": "string", "description": "The unique code representing a shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentNumber": { "type": "string", "description": "The alphanumeric number representing a shipment number.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentStatus" }, "orderedDeliveryService": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_OrderedDeliveryService" }, "shipmentSummaryInformation": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentSummaryInformation" } }, "description": "A delivery service order line's shipment header info.", "xml": { "name": "shipmentHeaderInfo" } }, "PartnerDeliveryServiceOrderService_ShipmentStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment status.", "example": "READY_FOR_SERVICE" }, "name": { "type": "string", "description": "The short name for the shipment status.", "example": "Ready for Service" }, "description": { "type": "string", "description": "The description of the shipment status.", "example": "The Shipment is Ready for Delivery Services." } }, "description": "A shipment header's status.", "xml": { "name": "shipmentStatus" } }, "PartnerDeliveryServiceOrderService_ShipmentSummaryInformation": { "required": [ "shipmentTotalOrderCount", "shipmentTotalShipmentLineCount", "shipmentTotalShipmentLineQuantity", "shipmentTotalValue" ], "type": "object", "properties": { "shipmentTotalValue": { "type": "number", "description": "The total value of the shipment.", "example": 13.42 }, "shipmentTotalOrderCount": { "type": "integer", "description": "The total count of orders in the shipment.", "format": "int32", "example": 13 }, "shipmentTotalShipmentLineCount": { "type": "integer", "description": "The total count of shipment lines in the shipment.", "format": "int32", "example": 13 }, "shipmentTotalShipmentLineQuantity": { "type": "integer", "description": "The total quantity in the shipment.", "format": "int32", "example": 1313 } }, "description": "Shipment summary information.", "xml": { "name": "shipmentSummaryInformation" } }, "PartnerDeliveryServiceOrderService_UnitOfMeasure": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the unit of measure.", "example": "INCH" }, "name": { "type": "string", "description": "The name representing the unit of measure.", "example": "inch" }, "description": { "type": "string", "description": "The description for the unit of measure.", "example": "Inch" } }, "description": "Describes measurement units.", "example": "POUND", "xml": { "name": "unitOfMeasure" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineDetail": { "type": "object", "properties": { "deliveryServiceOrderLineUuid": { "type": "string", "description": "The unique code representing an delivery service order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderHeaderUuid": { "type": "string", "description": "The unique code representing an delivery service order header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderLineNumber": { "type": "string", "description": "The alphanumeric number representing a delivery service order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderLineStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineStatus" }, "deliveryService": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryService" }, "deliveryServiceFees": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceFees" }, "deliveryServiceOrderLineError": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineError" }, "deliveryServiceOrderLinePrintDate": { "type": "string", "description": "The time that the delivery service order line was created", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deliveryServiceOrderLineOrderDate": { "type": "string", "description": "The time that the delivery service order line was ordered", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "A delivery service order line.", "xml": { "name": "deliveryServiceOrderLineDetail" } }, "PartnerDeliveryServiceOrderService_GetPartnerDeliveryServiceOrderLinesResponse": { "required": [ "totalServiceOrderLines" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalServiceOrderLines": { "type": "integer", "description": "The total number of delivery service order lines available for the service order header.", "format": "int32", "example": 27 }, "shipmentGroups": { "type": "array", "description": "The paged list of delivery service order lines, arranged by shipment group", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentGroupHeaderForLines" } } }, "xml": { "name": "getPartnerDeliveryServiceOrderLinesResponse" } }, "PartnerDeliveryServiceOrderService_PackageHeaderForShipment": { "required": [ "packageDimensions", "packageHeaderUuid", "packageName", "packageNumber", "packageStatus", "packageWeight", "serviceOrderLines" ], "type": "object", "properties": { "packageHeaderUuid": { "type": "string", "description": "The unique code representing a package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageNumber": { "type": "string", "description": "The number of a package header." }, "packageName": { "type": "string", "description": "The name of a package header." }, "packageStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageStatus" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageWeight" }, "serviceOrderLines": { "type": "array", "description": "The delivery service lines of a package header.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineDetail" } } }, "description": "A package header information.", "xml": { "name": "packageHeaderForShipment" } }, "PartnerDeliveryServiceOrderService_ShipmentGroupHeaderForLines": { "required": [ "createDate", "deliveryServiceFees", "groupNumber", "groupStatus", "groupSummaryInfo", "hasLineErrors", "shipmentGroupUuid", "shipmentHeaders" ], "type": "object", "properties": { "shipmentGroupUuid": { "type": "string", "description": "The unique code representing a shipment group.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "groupNumber": { "type": "string", "description": "The shipment group number.", "example": "SG9R4LT62WJP" }, "hasLineErrors": { "type": "boolean", "description": "The shipment group number has at least one delivery service order line with an error", "example": true }, "createDate": { "type": "string", "description": "The creation date of the shipment group", "format": "date-time" }, "groupStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentGroupHeaderStatus" }, "groupSummaryInfo": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentGroupSummaryInfo" }, "deliveryServiceFees": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceFees" }, "shipmentHeaders": { "type": "array", "description": "The list of shipment headers of the shipment group", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentHeaderForGroup" } } }, "description": "A shipment group information.", "xml": { "name": "shipmentGroupHeaderForLines" } }, "PartnerDeliveryServiceOrderService_ShipmentGroupSummaryInfo": { "required": [ "shipmentGroupValue", "shipmentHeaderCount", "skuCount", "skuQuantity" ], "type": "object", "properties": { "shipmentGroupValue": { "type": "number", "description": "The total value of the shipment group.", "example": 234.45 }, "shipmentHeaderCount": { "type": "integer", "description": "The total number of shipment headers in the group.", "format": "int32", "example": 4 }, "skuCount": { "type": "integer", "description": "The total number of unique SKUs in the shipping group.", "format": "int32", "example": 40 }, "skuQuantity": { "type": "integer", "description": "The total count of SKUs in the shipping group.", "format": "int32", "example": 400 } }, "description": "A shipment group summary information.", "xml": { "name": "shipmentGroupSummaryInfo" } }, "PartnerDeliveryServiceOrderService_ShipmentHeaderForGroup": { "required": [ "shipmentHeaderUuid", "shipmentNumber", "shipmentStatus" ], "type": "object", "properties": { "shipmentHeaderUuid": { "type": "string", "description": "The unique code representing a shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentNumber": { "type": "string", "description": "The number of the shipment header." }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentStatus" }, "orderedDeliveryService": { "type": "string", "description": "The ordered delivery service." }, "shipmentSummaryInfo": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_ShipmentSummaryInformation" }, "packageHeaders": { "type": "array", "description": "The packages of the shipment.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_PackageHeaderForShipment" } } }, "description": "A shipment header information.", "xml": { "name": "shipmentHeaderForGroup" } }, "PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLineStatusResponse": { "required": [ "deliveryServiceOrderHeaderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderHeaderUuid": { "type": "string", "description": "The unique code representing the deleted delivery service order header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "updateDeliveryServiceOrderLineStatusResponse" } }, "PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLineStatusRequest": { "required": [ "statusCode" ], "type": "object", "properties": { "shipmentGroupUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "A shipment group unique identifier. Mutually exclusive with 'orderLineUuids'", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderLineUuids": { "type": "array", "description": "A list of delivery service order line unique identifiers. Mutually exclusive with 'shipmentGroupUuid'", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of delivery service order line unique identifiers. Mutually exclusive with 'shipmentGroupUuid'", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "orderLineUuid" } } }, "statusCode": { "type": "string", "description": "The status code to which to set the related delivery service order lines to.", "enum": [ "READY_TO_PROCESS" ] } }, "xml": { "name": "updateDeliveryServiceOrderLineStatusRequest" } }, "PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLinesResponse": { "required": [ "deliveryServiceOrderHeaderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderHeaderUuid": { "type": "string", "description": "The unique code representing the deleted delivery service order header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "updateDeliveryServiceOrderLinesResponse" } }, "PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineUpdate": { "required": [ "additionalServiceCodes", "deliveryServiceOrderLineUuid", "serviceCode", "shipDate" ], "type": "object", "properties": { "deliveryServiceOrderLineUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string" }, "shipDate": { "type": "string", "description": "The intended ship date. Format: 2001-07-04T12:08:56.235-07:00", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "serviceCode": { "type": "string", "description": "A carrier service code", "example": "USPS_FIRST_CLASS_MAIL" }, "additionalServiceCodes": { "type": "array", "description": "A list of optional additional service codes", "example": "USPS_FIRST_CLASS_MAIL_SIGNATURE_CONFIRMATION_ELECTRONIC", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of optional additional service codes", "example": "USPS_FIRST_CLASS_MAIL_SIGNATURE_CONFIRMATION_ELECTRONIC", "xml": { "name": "additionalServiceCode" } } } }, "description": "A delivery service order line update.", "xml": { "name": "deliveryServiceOrderLineUpdate" } }, "PartnerDeliveryServiceOrderService_UpdateDeliveryServiceOrderLinesRequest": { "required": [ "orderLineUpdates" ], "type": "object", "properties": { "orderLineUpdates": { "type": "array", "description": "The list of order line updates", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_DeliveryServiceOrderLineUpdate" } } }, "xml": { "name": "updateDeliveryServiceOrderLinesRequest" } }, "PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderLinesResponse": { "required": [ "deliveryServiceOrderLineUuids", "failedPackageHeaders" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "deliveryServiceOrderLineUuids": { "type": "array", "description": "The unique code representing a created delivery service order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique code representing a created delivery service order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "deliveryServiceOrderLineUuid" } } }, "failedPackageHeaders": { "type": "array", "description": "Information for package headers that are invalid for creating delivery service order lines", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerDeliveryServiceOrderService_FailedPackageHeader" } } }, "xml": { "name": "createPartnerDeliveryServiceOrderLinesResponse" } }, "PartnerDeliveryServiceOrderService_FailedPackageHeader": { "required": [ "createDsolErrorCode", "createDsolErrorMessage" ], "type": "object", "properties": { "packageHeaderId": { "type": "string", "description": "The unique code representing a package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "createDsolErrorCode": { "type": "string", "description": "The code for why we cannot create a DSOL for a package header", "example": "POBoxExceedMaximumDimensions" }, "createDsolErrorMessage": { "type": "string", "description": "The code for why we cannot create a DSOL for a package header", "example": "Your package's dimensions are too large to ship with USPS and you cannot ship a package with UPS to a PO Box. Please choose different packaging that has a length shorter than 22in and enter new dimensions." } }, "description": "Information for package headers that are invalid for creating delivery service order lines", "xml": { "name": "failedPackageHeader" } }, "PartnerDeliveryServiceOrderService_CreatePartnerDeliveryServiceOrderLinesRequest": { "required": [ "deliveryServiceOptimizationCode", "shipDate", "shipmentGroupHeaderId" ], "type": "object", "properties": { "shipmentGroupHeaderId": { "type": "string", "description": "The shipment group header unique identifier." }, "deliveryServiceOptimizationCode": { "type": "string", "description": "The delivery service order optimization code." }, "shipDate": { "type": "string", "description": "The ship date.", "format": "date-time" } }, "xml": { "name": "createPartnerDeliveryServiceOrderLinesRequest" } }, "PartnerEmployeeService_GetPartnerEmployeeResponse": { "required": [ "employee" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "employee": { "$ref": "#/components/schemas/PartnerEmployeeService_partnerEmployee" } }, "xml": { "name": "getPartnerEmployeeResponse" } }, "PartnerEmployeeService_employeeType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The employee type code", "example": "PARTNER_SUCCESS_MANAGER" }, "name": { "type": "string", "description": "The employee type name", "example": "Partner Success Manager" }, "description": { "type": "string", "description": "The employee type description", "example": "Partner Success Manager" } }, "description": "The employee type", "xml": { "name": "employeeType" } }, "PartnerEmployeeService_employeeUserAccount": { "required": [ "employeeUserAccountUuid" ], "type": "object", "properties": { "employeeUserAccountUuid": { "type": "string", "description": "The unique identifier for an employee user account on a platform.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "An employee's user account information", "xml": { "name": "employeeUserAccount" } }, "PartnerEmployeeService_partnerEmployee": { "required": [ "emailAddress", "employeeType", "employeeUserAccount", "firstName", "fullName", "lastName", "phoneNumber" ], "type": "object", "properties": { "employeeUserAccount": { "$ref": "#/components/schemas/PartnerEmployeeService_employeeUserAccount" }, "employeeType": { "$ref": "#/components/schemas/PartnerEmployeeService_employeeType" }, "phoneNumber": { "$ref": "#/components/schemas/PartnerEmployeeService_phoneNumber" }, "emailAddress": { "type": "string", "description": "The employee's email address", "example": "Jon@Jtv.com" }, "firstName": { "type": "string", "description": "The employee's first name", "example": "Billy" }, "lastName": { "type": "string", "description": "The employee's last name", "example": "Thomas" }, "fullName": { "type": "string", "description": "The employee's full name", "example": "Thomas, Billy" } }, "description": "A platform employee for a partner.", "xml": { "name": "partnerEmployee" } }, "PartnerEmployeeService_phoneNumber": { "required": [ "countryCode", "phoneNumber" ], "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "The employee's phone number", "example": "6155841898" }, "countryCode": { "type": "integer", "description": "The phone number's country code.", "format": "int32", "example": 1 }, "extension": { "type": "string", "description": "The phone number's extension", "example": "6155" } }, "description": "An employee's phone number contact information.", "xml": { "name": "phoneNumber" } }, "PartnerEmployeeService_GetAllPartnerEmployeesResponse": { "required": [ "employees" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "employees": { "type": "array", "description": "The list of employees for the partner.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEmployeeService_partnerEmployee" } } }, "xml": { "name": "getAllPartnerEmployeesResponse" } }, "PartnerEmployeePermissionService_CompositeOperation": { "required": [ "description", "displayOrder", "name", "operations" ], "type": "object", "properties": { "name": { "type": "string", "description": "The short name for the composite operation's code.", "example": "View & Edit" }, "description": { "type": "string", "description": "The description of the composite operation's code.", "example": "The View & Edit composite operation allows a user to read, create, or update an entity." }, "displayOrder": { "type": "integer", "description": "The order that the composite operations should be displayed", "format": "int32", "example": 3 }, "operations": { "type": "array", "description": "The set of granular operations represented by the composite operation.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_GranularOperation" } } }, "description": "The compound 'verb' of the permission features. Combines many granular verbs, like 'View' and 'Edit'", "xml": { "name": "compositeOperation" } }, "PartnerEmployeePermissionService_EmployeePermission": { "required": [ "compositeOperation", "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the employee permission.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "assignment": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_EmployeePermissionAssignment" }, "compositeOperation": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_CompositeOperation" } }, "description": "In the context of a permission feature, this resource is used to describe further information about the 'verb' of the feature as well as other metadata.", "xml": { "name": "employeePermission" } }, "PartnerEmployeePermissionService_EmployeePermissionAssignment": { "required": [ "date", "id" ], "type": "object", "properties": { "id": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the employee permission assignment. Use this identifier when managing a permission assignment for an employee.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "date": { "type": "string", "description": "The date the permission was assigned to the employee.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "A resource that indicates metadata about a permission that has been assigned to an employee.", "xml": { "name": "employeePermissionAssignment" } }, "PartnerEmployeePermissionService_EmployeePermissionFeature": { "required": [ "code", "description", "displayOrder", "name", "permissions" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the permission's feature.", "example": "PC_PRODUCT_LISTINGS" }, "name": { "type": "string", "description": "The short name for the permission's feature.", "example": "Product Listings" }, "description": { "type": "string", "description": "A description of the permission's feature.", "example": "This feature allows the user to manage Product Listings Information." }, "displayOrder": { "type": "integer", "description": "The order that the employee permission features should be displayed", "format": "int32", "example": 3 }, "permissions": { "type": "array", "description": "The permissions associated with this feature.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_EmployeePermission" } } }, "description": "A feature describes the target or the 'what' part that a permission applies to.", "xml": { "name": "employeePermissionFeature" } }, "PartnerEmployeePermissionService_GetPartnerEmployeePermissionResponse": { "required": [ "categories" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "categories": { "type": "array", "description": "The set of categorized employee permission features.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_employeePermissionFeatureCategory" } } }, "xml": { "name": "getPartnerEmployeePermissionResponse" } }, "PartnerEmployeePermissionService_GranularOperation": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unqiue code representing the granular operation.", "example": "READ" }, "name": { "type": "string", "description": "The short name for the granular operation's code.", "example": "Read" }, "description": { "type": "string", "description": "The description of the granular operation's code.", "example": "Allows the user to perform a read operation on an entity." }, "displayOrder": { "type": "integer", "description": "The order that the granular operation should be displayed", "format": "int32", "example": 3 } }, "description": "The 'verb' of the permission feature. For example, 'View'.", "xml": { "name": "granularOperation" } }, "PartnerEmployeePermissionService_employeePermissionFeatureCategory": { "required": [ "code", "description", "displayOrder", "features", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the permission's feature.", "example": "LISTINGS" }, "name": { "type": "string", "description": "The short name for the permission's feature.", "example": "Listings" }, "description": { "type": "string", "description": "A description of the permission's feature.", "example": "The Listings feature category includes features related to managing product information." }, "displayOrder": { "type": "integer", "description": "The order that the employee permission feature categories should be displayed", "format": "int32", "example": 3 }, "features": { "type": "array", "description": "The features associated with this permissions category.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEmployeePermissionService_EmployeePermissionFeature" } } }, "description": "Category for an employee system feature used to group features that are alike or belong together logically.", "xml": { "name": "employeePermissionFeatureCategory" } }, "AgreementActionType": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } } }, "AgreementConsentingParty": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } } }, "AgreementMedia": { "type": "object", "properties": { "agreementMediaId": { "type": "integer", "format": "int64" }, "agreementUrl": { "type": "string" }, "mediaType": { "$ref": "#/components/schemas/AgreementMediaType" } } }, "AgreementMediaType": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } } }, "PartnerAgreement": { "type": "object", "properties": { "actionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementActionType" } }, "agreementRevisionUUID": { "type": "string" }, "code": { "type": "string" }, "consentingParty": { "$ref": "#/components/schemas/AgreementConsentingParty" }, "description": { "type": "string" }, "interactionState": { "type": "string", "enum": [ "AVAILABLE", "ACCEPTED" ] }, "lastConsentDatetime": { "type": "string", "format": "date-time" }, "lastConsentVersion": { "type": "string" }, "mediaList": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementMedia" } }, "name": { "type": "string" }, "title": { "type": "string" }, "version": { "type": "string" } }, "description": "List of terms of service URL.", "example": "flamingo.hk" }, "PartnerEnrollmentService_EnrollmentStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The code for the enrollment status.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "name": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The name for the enrollment status.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "description": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The description for the enrollment status.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "Information about the partner's service enrollment status", "xml": { "name": "enrollmentStatus" } }, "PartnerEnrollmentService_GetPartnerServicesResponse": { "required": [ "serviceEnrollments" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "serviceEnrollments": { "type": "array", "description": "The list of services the partner is enrolled in.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEnrollmentService_ServiceEnrollment" } } }, "xml": { "name": "getPartnerServicesResponse" } }, "PartnerEnrollmentService_ServiceAgreement": { "required": [ "agreementRevisionId", "version" ], "type": "object", "properties": { "agreementRevisionId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "Agreement revision UUID" }, "version": { "maxLength": 20, "minLength": 0, "type": "string", "description": "Agreement version" }, "code": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Agreement unique code" }, "name": { "type": "string", "description": "Agreement Name" }, "title": { "type": "string", "description": "Agreement title" } }, "description": "Partner Service agreement.", "example": "flamingo.hk", "xml": { "name": "serviceAgreement" } }, "PartnerEnrollmentService_ServiceClassification": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code for the service classification.", "example": "SHIPPING_CARRIER" }, "name": { "type": "string", "description": "The name for the service classification.", "example": "Shipping Carrier" }, "description": { "type": "string", "description": "The description for the service classification.", "example": "Shipping Carrier" }, "displayOrder": { "type": "integer", "description": "The display order for the service classification.", "format": "int32", "example": 1 } }, "description": "Information about the enrollment's service classification", "xml": { "name": "serviceClassification" } }, "PartnerEnrollmentService_ServiceEnrollment": { "required": [ "enrollmentEnrolledDateTime", "enrollmentRequestDateTime", "enrollmentStatus", "serviceEnrollmentId", "serviceOffering" ], "type": "object", "properties": { "serviceEnrollmentId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner's unique service enrollment universal id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "enrollmentRequestDateTime": { "type": "string", "description": "The date and time the partner requested enrollment in a service", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "enrollmentEnrolledDateTime": { "type": "string", "description": "The date and time the partner enrolled in a service", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "serviceOffering": { "$ref": "#/components/schemas/PartnerEnrollmentService_ServiceOffering" }, "enrollmentStatus": { "$ref": "#/components/schemas/PartnerEnrollmentService_EnrollmentStatus" } }, "description": "Information about the partner's service enrollment", "xml": { "name": "serviceEnrollment" } }, "PartnerEnrollmentService_ServiceOffering": { "required": [ "code", "complianceActionRequired", "description", "name", "offeringUrl", "parentServiceCode", "serviceDisplayOrder" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code for the service offering.", "example": "JTV_PARTNERED_CARRIER" }, "name": { "type": "string", "description": "The name for the service offering.", "example": "JTV Partnered Carrier" }, "description": { "type": "string", "description": "The description for the service offering.", "example": "The JTV Partnered Carrier Service offers a low-cost option to have goods shipped to and from JTV." }, "serviceDisplayOrder": { "type": "integer", "description": "The display order for the service offering.", "format": "int32", "example": 5 }, "parentServiceCode": { "type": "string", "description": "The code for the parent's service offering.", "example": "JTV_CONSIGNMENT" }, "serviceClassification": { "type": "array", "description": "Describes the service offering the partner is enrolled in.", "xml": { "name": "serviceClassifications", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEnrollmentService_ServiceClassification" } }, "offeringUrl": { "type": "string", "description": "The URL for features and benefits.", "example": "flamingo.hk" }, "termsOfServiceUrlList": { "type": "array", "description": "List of terms of service URL.", "example": "flamingo.hk", "items": { "$ref": "#/components/schemas/PartnerAgreement" } }, "agreements": { "type": "array", "description": "List of Service Agreements.", "example": "flamingo.hk", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEnrollmentService_ServiceAgreement" } }, "childServiceOffering": { "type": "array", "description": "Describes the child services for this parent service.", "xml": { "name": "childServiceOfferings", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEnrollmentService_ServiceOffering" } }, "complianceActionRequired": { "type": "boolean", "description": "The indicator as to whether a compliance action is required. Example: Patriot Act Questionnaire" } }, "description": "Information about the partner's service offering", "xml": { "name": "serviceOffering" } }, "PartnerEnrollmentService_PartnerServiceEnrollmentResponse": { "required": [ "serviceEnrollmentUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "serviceEnrollmentUuid": { "type": "string", "description": "The unique identifier of the service enrollment." } }, "xml": { "name": "partnerServiceEnrollmentResponse" } }, "PartnerEnrollmentService_PartnerServiceEnrollmentRequest": { "required": [ "serviceCode" ], "type": "object", "properties": { "serviceCode": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The service enrollment service code." } }, "xml": { "name": "PartnerServiceEnrollmentRequest" } }, "PartnerEnrollmentService_GetPartnerServiceOfferingResponse": { "required": [ "serviceOffering" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "serviceOffering": { "type": "array", "description": "The list of eligible services for enrollment.", "xml": { "name": "serviceOfferings", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerEnrollmentService_ServiceOffering" } } }, "xml": { "name": "getPartnerServiceOfferingResponse" } }, "PartnerFulfillmentPackageService_UpdatePackageLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLineUuuidList": { "type": "array", "items": { "type": "string" } } }, "xml": { "name": "updatePackageLinesResponse" } }, "PartnerFulfillmentPackageService_UpdatePackageLine": { "required": [ "packageLineId", "quantity" ], "type": "object", "properties": { "packageLineId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing package line to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "The package line quantity", "format": "int32" } }, "description": "The package line quantity list to update", "xml": { "name": "updatePackageLine" } }, "PartnerFulfillmentPackageService_UpdatePackageLinesRequest": { "required": [ "updatePackageLineList" ], "type": "object", "properties": { "updatePackageLineList": { "type": "array", "description": "The package line quantity list to update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageLine" } } }, "xml": { "name": "updatePackageLinesRequest" } }, "PartnerFulfillmentService_CreatePackagerHeaderResponse": { "required": [ "packageId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageId": { "type": "string", "description": "The unique code representing the package header created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPackagerHeaderResponse" } }, "PartnerFulfillmentPackageService_CreatePartnerFulfillmentPackageHeaderRequest": { "type": "object", "properties": { "originShipmentLineId": { "type": "string", "description": "Optional Parameter indicating that the client wishes to remove Package Lines within the origin Package Header(s), and create a new Package Line within the New Package Header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerFulfillmentPackageHeaderRequest" } }, "PartnerFulfillmentPackageService_UpdatePackageHeader": { "required": [ "packageId" ], "type": "object", "properties": { "packageId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing package header to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageMeasurementPresetId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The package measurement preset unit identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packagingProductTypeCode": { "type": "string", "description": "The unique code representing a packaging product type.", "example": "POLY_BUBBLE_MAILER", "enum": [ "POLY_BUBBLE_MAILER", "KRAFT_BUBBLE_MAILER", "POLY_MAILER_BAG", "CORRUGATED_BOX", "PAPERBOARD_BOX" ] }, "packageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentService_UpdatePackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentService_UpdatePackageWeight" } }, "description": "The package header list to update", "xml": { "name": "updatePackageHeader" } }, "PartnerFulfillmentPackageService_UpdatePackageHeaderListRequest": { "required": [ "updatePackageHeaders" ], "type": "object", "properties": { "updatePackageHeaders": { "type": "array", "description": "The package header list to update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentPackageService_UpdatePackageHeader" } } }, "xml": { "name": "updatePackageHeaderListRequest" } }, "PartnerFulfillmentService_UpdatePackageDimensions": { "required": [ "packageDimensionsUnitOfMeasureCode", "packageHeight", "packageLength", "packageWidth" ], "type": "object", "properties": { "packageLength": { "minimum": 0, "type": "number", "description": "The length of the package.", "format": "double", "example": 11.36 }, "packageWidth": { "minimum": 0, "type": "number", "description": "The width of the package.", "format": "double", "example": 7.12 }, "packageHeight": { "minimum": 0, "type": "number", "description": "The height of the package.", "format": "double", "example": 5.45 }, "packageDimensionsUnitOfMeasureCode": { "type": "string", "description": "Describes the package dimensions unit of measure", "example": "INCH, CENTIMETER", "xml": { "name": "packageDimensionsUnitOfMeasureCode" }, "enum": [ "INCH", "CENTIMETER" ] } }, "description": "Package dimensions data transfer object", "xml": { "name": "packageDimensions" } }, "PartnerFulfillmentService_UpdatePackageWeight": { "required": [ "packageWeight", "packageWeightUnitOfMeasureCode" ], "type": "object", "properties": { "packageWeight": { "minimum": 0, "type": "number", "description": "The weight of the package.", "format": "double", "example": 13.33 }, "packageWeightUnitOfMeasureCode": { "type": "string", "description": "Describes the package weight's available unit of measure", "example": "POUND, KILOGRAM, OUNCE", "xml": { "name": "packageWeightUnitOfMeasureCode" }, "enum": [ "POUND", "OUNCE", "KILOGRAM" ] } }, "description": "Package weight update data transfer object", "xml": { "name": "packageWeight" } }, "PartnerFulfillmentPackageService_DeletePackageHeadersRequest": { "required": [ "packageHeaderIds" ], "type": "object", "properties": { "packageHeaderIds": { "type": "array", "description": "The unique identifiers of the package headers to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the package headers to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "packageHeaderId" } } } }, "xml": { "name": "deletePackageHeadersRequest" } }, "PartnerFulfillmentService_GetPackageHeaderResponse": { "required": [ "packageHeader" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageHeader": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageHeader" } }, "xml": { "name": "getPackageHeaderResponse" } }, "PartnerFulfillmentService_PackageDimensions": { "required": [ "packageDimensionsUnitOfMeasureCode", "packageHeight", "packageLength", "packageWidth" ], "type": "object", "properties": { "packageLength": { "type": "number", "description": "The length of the package.", "format": "double", "example": 11.36 }, "packageWidth": { "type": "number", "description": "The width of the package.", "format": "double", "example": 7.12 }, "packageHeight": { "type": "number", "description": "The height of the package.", "format": "double", "example": 5.45 }, "packageDimensionsUnitOfMeasureCode": { "type": "string", "description": "Describes the package dimensions unit of measure", "example": "INCH, CENTIMETER", "xml": { "name": "packageDimensionsUnitOfMeasureCode" }, "enum": [ "INCH", "CENTIMETER" ] } }, "description": "Describes the package dimensions", "xml": { "name": "packageDimensions" } }, "PartnerFulfillmentService_PackageHeader": { "type": "object", "properties": { "packageId": { "type": "string", "description": "The package's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageNumber": { "type": "string", "description": "The package number", "example": "SCPPALWCRU-001" }, "packageOrdinal": { "type": "integer", "description": "The ordinal for list sorting", "format": "int32", "example": 1 }, "packageName": { "type": "string", "description": "The package name", "example": "Package 1" }, "packageStatusCode": { "type": "string", "description": "The package status code", "example": "READY_TO_PACK" }, "packageStatusName": { "type": "string", "description": "The package status name", "example": "Ready to Pack" }, "packingProductTypeCode": { "type": "string", "description": "The packaging product type code" }, "packageSummaryInformation": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageSummaryInformation" }, "packageMeasurementPreset": { "type": "object", "additionalProperties": { "type": "string" } }, "packageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageWeight" } }, "description": "Describes package header", "xml": { "name": "packageHeader" } }, "PartnerFulfillmentService_PackageSummaryInformation": { "type": "object", "properties": { "packageTotalValue": { "type": "number", "description": "The package total dollar value", "format": "double", "example": 95.99 }, "packageTotalOrderLineCount": { "type": "integer", "description": "The package line count", "format": "int32", "example": 2 }, "packageTotalOrderLineQuantity": { "type": "integer", "description": "The package total quantity", "format": "int32", "example": 10 } }, "description": "Describes package summary information", "xml": { "name": "packageSummaryInformation" } }, "PartnerFulfillmentService_PackageWeight": { "required": [ "packageWeight", "packageWeightUnitOfMeasureCode" ], "type": "object", "properties": { "packageWeight": { "type": "number", "description": "The weight of the package.", "format": "double", "example": 13.33 }, "packageWeightUnitOfMeasureCode": { "type": "string", "description": "Describes the package weight's available unit of measure", "example": "POUND, KILOGRAM, OUNCE", "xml": { "name": "packageWeightUnitOfMeasureCode" }, "enum": [ "POUND", "OUNCE", "KILOGRAM" ] } }, "description": "Describes the package weight", "xml": { "name": "packageWeight" } }, "PartnerFulfillmentService_GetPackageHeadersResponse": { "required": [ "packageHeaders", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalListCount": { "type": "integer", "description": "The package list count", "format": "int32" }, "packageHeaders": { "type": "array", "description": "A list of partner fulfillment packages", "items": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageHeader" } } }, "xml": { "name": "getPackageHeadersResponse" } }, "PartnerFulfillmentService_CreatePackageLineResponse": { "required": [ "packageLineId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLineId": { "type": "string", "description": "The unique code representing the package line created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPackageLineResponse" } }, "PartnerFulfillmentPackageService_CreatePackageLineRequest": { "required": [ "packageLine" ], "type": "object", "properties": { "packageLine": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePackageLine" } }, "xml": { "name": "createPackageLineRequest" } }, "PartnerFulfillmentService_CreatePackageLine": { "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "The unique universal id of the shipment line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "The line quantity.", "format": "int32" }, "originShipmentLineId": { "type": "string", "description": "Optional Parameter indicating that the client wishes to remove Package Lines within the origin Package Header(s), and create a new Package Line within the destination Package Header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "Create Package Line", "xml": { "name": "createPackageLine" } }, "PartnerFulfillmentPackageService_DeletePackageLInesRequest": { "required": [ "packageLineIds" ], "type": "object", "properties": { "packageLineIds": { "type": "array", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "packageLineId" } } } }, "xml": { "name": "deletePackageLInesRequest" } }, "PartnerFulfillmentService_GetPackageLinesResponse": { "required": [ "packageLineList", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalListCount": { "type": "integer", "description": "Total line count", "format": "int32" }, "packageLineList": { "type": "array", "description": "A list of partner fulfillment package line", "items": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageLine" } } }, "xml": { "name": "getPackageLinesResponse" } }, "PartnerFulfillmentService_PackageLine": { "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The package line's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentLineId": { "type": "string", "description": "The shipment line's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageLineNumber": { "type": "integer", "description": "The line number for list sorting", "format": "int32" }, "packageLineQuantity": { "type": "integer", "description": "The package line quantity", "format": "int32" }, "productNumber": { "type": "string", "description": "The product number" }, "styleNumber": { "type": "string", "description": "The style number" }, "skuNumber": { "type": "string", "description": "The SKU number" }, "skuSize": { "type": "string", "description": "The SKU size" }, "basePrice": { "type": "number", "description": "The SKU base price", "format": "double" }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number" }, "supplierStyleNumber": { "type": "string", "description": "The supplier style number" }, "styleImageUrl": { "type": "string", "description": "The product image URL" }, "styleTitleDescription": { "type": "string", "description": "The product description" }, "serviceLines": { "type": "array", "description": "The service items", "items": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageServiceLine" } } }, "description": "Describes package line", "xml": { "name": "packageLine" } }, "PartnerFulfillmentService_PackageServiceLine": { "type": "object", "properties": { "serviceLineNumber": { "type": "integer", "description": "The service item line number", "format": "int32" }, "serviceSkuNumber": { "type": "string", "description": "The service item SKU number" }, "serviceTypeCode": { "type": "string", "description": "The service item type code" }, "serviceTypeName": { "type": "string", "description": "The service item type name" }, "serviceTypeDescription": { "type": "string", "description": "The service type description" } }, "description": "Describes package line service items", "xml": { "name": "packageServiceLine" } }, "PartnerFulfillmentService_GetPackageLineResponse": { "required": [ "packageLine" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLine": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageLine" } }, "xml": { "name": "getPackageLineResponse" } }, "PartnerFulfillmentPackageService_CreatePackageLabelsRequest": { "required": [ "includeOrderInfo", "packageLabelType" ], "type": "object", "properties": { "packageLabelType": { "type": "string", "description": "A code describing the format of the labels to return", "example": "LABEL_FOUR_X_SIX_LABEL", "enum": [ "LETTER_ONE_PER_PAGE", "LETTER_TWO_PER_PAGE", "LABEL_FOUR_X_SIX_LABEL" ] }, "includeOrderInfo": { "type": "boolean", "description": "Include order information on each label?", "example": true }, "orderHeaderUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier of a delivery service order header from which to find packages to label", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentBatchHeaderUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier of a shipment batch header from which to find packages to label", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentGroupHeaderUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier of a shipment group header from which to find packages to label", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageHeaderUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier of a shipment header from which to find packages to label", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentHeaderUuids": { "type": "array", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "shipmentHeaderUuid" } } } }, "xml": { "name": "createPackageLabelsRequest" } }, "PartnerFulfillmentPackageService_CreatePackageManifestRequest": { "required": [ "originSiteUuid", "shipDate" ], "type": "object", "properties": { "shipDate": { "type": "string", "description": "The ship date. Format: 2001-07-04T12:08:56.235-07:00", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "originSiteUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string" } }, "xml": { "name": "createPackageManifestRequest" } }, "PartnerFulfillmentService_CreatePackageManagementPresetResponse": { "required": [ "packagePresetUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packagePresetUuid": { "type": "string", "description": "The unique code representing the package measurement preset created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPackageManagementPresetResponse" } }, "PartnerFulfillmentPackageService_CreatePackageMeasurementPresetRequest": { "required": [ "partnerPackageMeasurementPreset" ], "type": "object", "properties": { "partnerPackageMeasurementPreset": { "$ref": "#/components/schemas/PartnerFulfillmentService_CreatePartnerPackageMeasurementPreset" } }, "xml": { "name": "createPackageMeasurementPresetRequest" } }, "PartnerFulfillmentService_CreatePartnerPackageMeasurementPreset": { "required": [ "displayName", "packageDimensions", "packagingProductTypeCode" ], "type": "object", "properties": { "displayName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Package Measurement Preset Display Name", "example": "My Small Box" }, "packagingProductTypeCode": { "type": "string", "description": "The packaging type code.", "example": "POLY_BUBBLE_MAILER, KRAFT_BUBBLE_MAILER, POLY_MAILER_BAG, CORRUGATED_BOX, PAPERBOARD_BOX", "enum": [ "POLY_BUBBLE_MAILER", "KRAFT_BUBBLE_MAILER", "POLY_MAILER_BAG", "CORRUGATED_BOX", "PAPERBOARD_BOX" ] }, "packageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageWeight" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageDimensions" } }, "description": "Create Partner Package Management Preset", "xml": { "name": "createPartnerPackageMeasurementPreset" } }, "PartnerFulfillmentPackageService_UpdatePackageMeasurementPresetRequest": { "required": [ "partnerPackageMeasurementPreset" ], "type": "object", "properties": { "partnerPackageMeasurementPreset": { "$ref": "#/components/schemas/PartnerFulfillmentService_UpdatePartnerPackageMeasurementPreset" } }, "xml": { "name": "updatePackageMeasurementPresetRequest" } }, "PartnerFulfillmentService_UpdatePartnerPackageMeasurementPreset": { "required": [ "displayName", "packageDimensions", "packagingProductTypeCode" ], "type": "object", "properties": { "displayName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Package Measurement Preset Display Name", "example": "My Small Box" }, "packagingProductTypeCode": { "type": "string", "description": "The packaging type code.", "example": "POLY_BUBBLE_MAILER, KRAFT_BUBBLE_MAILER, POLY_MAILER_BAG, CORRUGATED_BOX, PAPERBOARD_BOX", "enum": [ "POLY_BUBBLE_MAILER", "KRAFT_BUBBLE_MAILER", "POLY_MAILER_BAG", "CORRUGATED_BOX", "PAPERBOARD_BOX" ] }, "packageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageWeight" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageDimensions" }, "displayOrder": { "type": "integer", "description": "Package Measurement Preset Display Order (optional)", "format": "int32", "example": 20 } }, "description": "Partner Package Management Preset", "xml": { "name": "partnerPackageMeasurementPreset" } }, "PartnerFulfillmentService_GetPartnerPackageMeasurementsPresetsResponse": { "required": [ "partnerPackageMeasurementPresets", "resultCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "resultCount": { "type": "integer", "description": "A count of partner package measurement presets returned", "format": "int32", "xml": { "wrapped": true } }, "partnerPackageMeasurementPresets": { "type": "array", "description": "A list of partner package measurement presets", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentService_PartnerPackageMeasurementPreset" } } }, "xml": { "name": "getPartnerPackageMeasurementsPresetsResponse" } }, "PartnerFulfillmentService_PackagePresetDimensions": { "required": [ "packageHeight", "packageLength", "packageWidth" ], "type": "object", "properties": { "packageLength": { "maximum": 999.9999, "exclusiveMaximum": false, "minimum": 0, "type": "number", "description": "The length of the package.", "format": "double", "example": 11.36 }, "packageWidth": { "maximum": 999.9999, "exclusiveMaximum": false, "minimum": 0, "type": "number", "description": "The width of the package.", "format": "double", "example": 7.12 }, "packageHeight": { "maximum": 999.9999, "exclusiveMaximum": false, "minimum": 0, "type": "number", "description": "The height of the package.", "format": "double", "example": 5.45 } }, "description": "Describes the package preset dimensions", "xml": { "name": "packagePresetDimensions" } }, "PartnerFulfillmentService_PackagePresetWeight": { "required": [ "packageWeight", "packageWeightUnitOfMeasure" ], "type": "object", "properties": { "packageWeight": { "type": "number", "description": "The weight of the package.", "format": "double", "example": 13.33 }, "packageWeightUnitOfMeasure": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageWeightUnitOfMeasure" } }, "description": "Describes the package preset weight", "xml": { "name": "packagePresetWeight" } }, "PartnerFulfillmentService_PackageWeightUnitOfMeasure": { "type": "object", "properties": { "packageWeightUOMName": { "type": "string", "description": "The name of the unit of measure.", "example": "centimeter" }, "packageWeightUOMDescription": { "type": "string", "description": "The description of the unit of measure.", "example": "Centimeter" }, "packageWeightUOMCode": { "type": "string", "description": "Describes the package weight's available unit of measure", "example": "CENTIMETER", "xml": { "name": "packageWeightUnitOfMeasureCode" }, "enum": [ "POUND", "OUNCE", "KILOGRAM" ] } }, "description": "Describes the weight unit of measure", "example": "POUND, KILOGRAM, OUNCE", "xml": { "name": "packageWeightUnitOfMeasure" } }, "PartnerFulfillmentService_PartnerFulfillmentPackagingType": { "type": "object", "properties": { "packagingProductTypeName": { "type": "string", "description": "The name of the packaging product type.", "example": "Poly Bubble Mailer" }, "packagingProductTypeDescription": { "type": "string", "description": "The description of the packaging product type.", "example": "Poly Bubble Mailer Envelope" }, "packagingProductTypeCode": { "type": "string", "description": "The code of the packaging product type.", "example": "POLY_BUBBLE_MAILER", "enum": [ "POLY_BUBBLE_MAILER", "KRAFT_BUBBLE_MAILER", "POLY_MAILER_BAG", "CORRUGATED_BOX", "PAPERBOARD_BOX" ] } }, "description": "Describes the packaging type", "xml": { "name": "packagingProductType" } }, "PartnerFulfillmentService_PartnerPackageMeasurementPreset": { "required": [ "displayName", "packageDimensions", "packageWeight" ], "type": "object", "properties": { "packagePresetUuid": { "type": "string", "description": "The package preset id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "displayName": { "type": "string", "description": "Package Measurement Preset Display Name", "example": "My Small Box" }, "displayOrder": { "type": "integer", "description": "Package Measurement Preset Display Order", "format": "int32", "example": 20 }, "packagingProductType": { "$ref": "#/components/schemas/PartnerFulfillmentService_PartnerFulfillmentPackagingType" }, "packageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackagePresetWeight" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackagePresetDimensions" }, "createdByUser": { "$ref": "#/components/schemas/PartnerFulfillmentService_User" }, "modifiedByUser": { "$ref": "#/components/schemas/PartnerFulfillmentService_User" }, "active": { "type": "boolean", "description": "Package Measurement Preset Flag For Active", "example": true } }, "description": "Partner Package Management Preset", "xml": { "name": "partnerPackageMeasurementPreset" } }, "PartnerFulfillmentService_User": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User First Name", "example": "Holly" }, "lastName": { "type": "string", "description": "User Last Name", "example": "Golightly" }, "username": { "type": "string", "description": "Username", "example": "hollly.golightly@jtv.com" }, "uuid": { "type": "string", "description": "User ID", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "userId" } } }, "description": "Partner Package Management Preset User" }, "PartnerFulfillmentService_GetPartnerPackageMeasurementPresetByUuidResponse": { "required": [ "partnerPackageMeasurementPreset" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerPackageMeasurementPreset": { "$ref": "#/components/schemas/PartnerFulfillmentService_PartnerPackageMeasurementPreset" } }, "xml": { "name": "getPartnerPackageMeasurementPresetByUuidResponse" } }, "PartnerFulfillmentService_GetTrackingEventsResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageTrackingEventSummary": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageTrackingEventSummary" } }, "xml": { "name": "getTrackingEventsResponse" } }, "PartnerFulfillmentService_PackageDeliveryDates": { "type": "object", "properties": { "eddBeginDate": { "type": "string", "description": "The package's estimated delivers begin date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "eddEndDate": { "type": "string", "description": "The package's estimated delivers end date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deliveryDate": { "type": "string", "description": "The package's estimated delivers date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The package delivery dates.", "xml": { "name": "packageDeliveryDates" } }, "PartnerFulfillmentService_PackageTrackingBaseLocation": { "type": "object", "properties": { "city": { "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "type": "string", "description": "Address State or Province Abbreviation", "example": "TN" }, "zip": { "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922-6748" }, "country": { "type": "string", "description": "Address Country Abbreviation", "example": "USA" } }, "description": "Package tracking location", "xml": { "name": "packageTrackingBaseLocation" } }, "PartnerFulfillmentService_PackageTrackingEvent": { "type": "object", "properties": { "eventDate": { "type": "string", "description": "The event date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "eventStatusCode": { "type": "string", "description": "The event status code.", "example": "DELIVERED_GENERAL" }, "eventStatusDisplayName": { "type": "string", "description": "The event status display name.", "example": "Delivered: General" }, "eventStatusDescription": { "type": "string", "description": "The event status description.", "example": "Delivered: General" }, "eventStatusDisplayOrder": { "type": "integer", "description": "The event status display order.", "format": "int32", "example": 1 }, "location": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageTrackingBaseLocation" } }, "description": "Package tracking", "xml": { "name": "packageTrackingEvent" } }, "PartnerFulfillmentService_PackageTrackingEventSummary": { "type": "object", "properties": { "packageNumber": { "type": "string", "description": "The package number.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageOrdinal": { "type": "integer", "description": "The package's order in shipment.", "format": "int32", "example": 1 }, "carrier": { "$ref": "#/components/schemas/PartnerFulfillmentService_PartnerTrackingCarrier" }, "currentStatus": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageTrackingStatus" }, "delivery": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageDeliveryDates" }, "events": { "type": "array", "description": "The package tracking events for this package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentService_PackageTrackingEvent" } } }, "description": "The summary of the package tracking events the package, including the list of package tracking events", "xml": { "name": "packageTrackingEventSummary" } }, "PartnerFulfillmentService_PackageTrackingStatus": { "required": [ "statusCode", "statusDate", "statusDescription", "statusDisplayName", "statusDisplayOrder" ], "type": "object", "properties": { "statusCode": { "type": "string", "description": "The unique code representing package status.", "example": "DELIVERED" }, "statusDisplayName": { "type": "string", "description": "The display name for status.", "example": "Delivered" }, "statusDescription": { "type": "string", "description": "The description for the package status.", "example": "Delivered" }, "statusDisplayOrder": { "type": "integer", "description": "The status display order.", "format": "int32", "example": 1 }, "statusDate": { "type": "string", "description": "The date for the package status.", "format": "date-time" } }, "description": "The current status of the package.", "xml": { "name": "packageTrackingStatus" } }, "PartnerFulfillmentService_PartnerTrackingCarrier": { "type": "object", "properties": { "carrierCode": { "type": "string", "description": "The code representing a carrier.", "example": "UPS" }, "carrierDisplayName": { "type": "string", "description": "The carrier display name.", "example": "United Parcel Service (UPS)" }, "carrierDescription": { "type": "string", "description": "The carrier description.", "example": "United Parcel Service" }, "serviceCode": { "type": "string", "description": "The service code.", "example": "UPS_GROUND" }, "serviceDisplayName": { "type": "string", "description": "The carrier service display name.", "example": "UPS Ground" }, "serviceDescription": { "type": "string", "description": "The carrier service description.", "example": "UPS Ground" }, "partnerCarrierCode": { "type": "string", "description": "The partner carrier code.", "example": "UPS" }, "partnerCarrierDisplayName": { "type": "string", "description": "The partner carrier display name.", "example": "United Parcel Service (UPS)" }, "partnerCarrierDescription": { "type": "string", "description": "The partner carrier description.", "example": "United Parcel Service" }, "partnerTrackingNumber": { "type": "string", "description": "The partner tracking number.", "example": "partnerTrackingNumber" } }, "description": "The package carrier.", "xml": { "name": "partnerTrackingCarrier" } }, "PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentHeaderResponse": { "required": [ "packageHeaderId", "shipmentHeaderId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderId": { "type": "string", "description": "The unique code representing an existing fulfillment shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageHeaderId": { "type": "string", "description": "The unique code representing an existing fulfillment package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerFulfillmentShipmentHeaderResponse" } }, "PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentHeaderRequest": { "type": "object", "properties": { "shipmentHeaderTypeCode": { "type": "string", "description": "The code representing the shipment header type", "enum": [ "CUSTOMER_SALES_SHIPMENT" ] }, "originSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's origin site" }, "returnSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's return site" }, "customerId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the customer" }, "customerShipAddressId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for a ship address associated with the customer" }, "originShipmentLineId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for a shipment line" } }, "xml": { "name": "createPartnerFulfillmentShipmentHeaderRequest" } }, "PartnerFulfillmentShipmentService_UpdatePartnerFulfillmentShipmentHeaderResponse": { "required": [ "shipmentId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentId": { "type": "string", "description": "The unique UUID of the shipment header" } }, "xml": { "name": "updatePartnerFulfillmentShipmentHeaderResponse" } }, "PartnerFulfillmentShipmentService_UpdatePartnerFulfillmentShipmentHeaderRequest": { "type": "object", "properties": { "originSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's origin site" }, "returnSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's return site" } }, "xml": { "name": "updatePartnerFulfillmentShipmentHeaderRequest" } }, "PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentHeaderResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerFulfillmentShipmentHeaderResponse" } }, "PartnerFulfillmentService_CustomerShipAddressInformation": { "required": [ "addressId", "addressLineOne", "addressLineTwo", "city", "countryCode", "firstName", "lastName", "phone", "postalCode", "state" ], "type": "object", "properties": { "addressId": { "type": "string", "description": "The address Id for Customer address" }, "firstName": { "type": "string", "description": "The first name for the shipment." }, "lastName": { "type": "string", "description": "The last name for the shipment." }, "addressLineOne": { "type": "string", "description": "The first line of the customer address." }, "addressLineTwo": { "type": "string", "description": "The second line of the customer address." }, "city": { "type": "string", "description": "The city of the customer address." }, "state": { "type": "string", "description": "The state of the customer address." }, "countryCode": { "type": "string", "description": "The country code of the customer address." }, "postalCode": { "type": "string", "description": "The postal code of the customer address." }, "phone": { "type": "string", "description": "The phone number of the customer." } }, "description": "Customer Shipment Summary Information", "xml": { "name": "CustomerShipAddressInformation" } }, "PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentHeadersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "filteredListCount": { "type": "integer", "description": "The number of shipment headers that passed any active filters.", "format": "int32" }, "totalListCount": { "type": "integer", "description": "The total number of shipment headers for this partner, without any filters.", "format": "int32" }, "shipmentHeaders": { "type": "array", "description": "The paged list of shipment headers that satisfy the filter criteria.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeader" } } }, "xml": { "name": "getPartnerFulfillmentShipmentHeadersResponse" } }, "PartnerFulfillmentShipmentService_PackageDimensions": { "required": [ "packageDimensionsUnitOfMeasureCode", "packageHeight", "packageLength", "packageWidth" ], "type": "object", "properties": { "packageLength": { "type": "number", "description": "The length of the package.", "format": "double", "example": 11.36 }, "packageWidth": { "type": "number", "description": "The width of the package.", "format": "double", "example": 7.12 }, "packageHeight": { "type": "number", "description": "The height of the package.", "format": "double", "example": 5.45 }, "packageDimensionsUnitOfMeasureCode": { "type": "string", "description": "A package header dimension UOM code", "example": "INCH, CENTIMETER", "xml": { "name": "PackageDimensionsUnitOfMeasureCode" }, "enum": [ "INCH", "CENTIMETER" ] } }, "description": "A package header dimensions", "xml": { "name": "packageDimensions" } }, "PartnerFulfillmentShipmentService_PackageSummaryInformation": { "type": "object", "properties": { "packageTotalValue": { "type": "number", "description": "The package total dollar value", "format": "double", "example": 95.99 }, "packageTotalOrderLineCount": { "type": "integer", "description": "The package line count", "format": "int32", "example": 2 }, "packageTotalOrderLineQuantity": { "type": "integer", "description": "The package total quantity", "format": "int32", "example": 10 } }, "description": "A package header summary", "xml": { "name": "packageSummaryInformation" } }, "PartnerFulfillmentShipmentService_PackageWeight": { "required": [ "packageWeight", "packageWeightUnitOfMeasureCode" ], "type": "object", "properties": { "packageWeight": { "maximum": 999.999, "exclusiveMaximum": false, "type": "number", "description": "The weight of the package.", "format": "double", "example": 13.33 }, "packageWeightUnitOfMeasureCode": { "type": "string", "description": "A package header weight UOM code", "example": "POUND, KILOGRAM, OUNCE", "xml": { "name": "packageWeightUnitOfMeasureCode" }, "enum": [ "POUND", "OUNCE", "KILOGRAM" ] } }, "description": "A package header weight", "xml": { "name": "packageWeight" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentPackageHeader": { "type": "object", "properties": { "packageId": { "type": "string", "description": "The package's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageOrdinal": { "type": "integer", "description": "The ordinal for list sorting", "format": "int32", "example": 1 }, "packageName": { "type": "string", "description": "The package name", "example": "Package 1" }, "packageStatusCode": { "type": "string", "description": "The package status code", "example": "READY_TO_PACK" }, "packageStatusName": { "type": "string", "description": "The package status name", "example": "Ready to Pack" }, "packingProductTypeCode": { "type": "string", "description": "The packaging product type code" }, "packageSummaryInformation": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PackageSummaryInformation" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PackageWeight" }, "packageLines": { "type": "array", "description": "The list of package lines.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentPackageLine" } } }, "description": "A package header", "xml": { "name": "partnerFulfillmentPackageHeader" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentPackageLine": { "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The package line's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageLineNumber": { "type": "integer", "description": "The line number for list sorting", "format": "int32" }, "packageLineQuantity": { "type": "integer", "description": "The package line quantity", "format": "int32" }, "productNumber": { "type": "string", "description": "The product number" }, "styleNumber": { "type": "string", "description": "The style number" }, "skuNumber": { "type": "string", "description": "The SKU number" }, "skuSize": { "type": "string", "description": "The SKU size" }, "basePrice": { "type": "number", "description": "The SKU base price", "format": "double" }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number" }, "supplierStyleNumber": { "type": "string", "description": "The supplier style number" }, "styleImageUrl": { "type": "string", "description": "The product image URL" }, "styleTitleDescription": { "type": "string", "description": "The product description" } }, "description": "A package line", "xml": { "name": "partnerFulfillmentPackageLine" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeader": { "required": [ "customerFirstName", "customerId", "customerLastName", "customerShipAddressInformation", "originSiteId", "returnSiteId", "shipmentHeaderId", "shipmentNumber", "shipmentStatus" ], "type": "object", "properties": { "shipmentHeaderId": { "type": "string", "description": "The UUID of the shipment." }, "shipmentNumber": { "type": "string", "description": "The shipment number." }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderStatus" }, "customerId": { "type": "string", "description": "The customer UUID." }, "customerShipAddressInformation": { "$ref": "#/components/schemas/PartnerFulfillmentService_CustomerShipAddressInformation" }, "originSiteId": { "type": "string", "description": "The site UUID of the origin of the shipment." }, "returnSiteId": { "type": "string", "description": "The UUID of the return site of the shipment." }, "totalValue": { "type": "number", "description": "The total value of all orders in the shipment.", "format": "double" }, "totalOrderLineCount": { "type": "integer", "description": "The number of order lines in the shipment.", "format": "int32" }, "totalOrderLineQuantity": { "type": "integer", "description": "The total unit quantity for all orders in this shipment.", "format": "int32" }, "receiptQuantity": { "type": "integer", "description": "Sum of Non-Cancelled Receipt Line Quantity for the Shipment Header.", "format": "int32" }, "receivableQuantity": { "type": "integer", "description": "Quantity which may be Received for the Shipment Header.", "format": "int32" }, "minOrderDate": { "type": "string", "description": "The minimum date across all orders in this shipment.", "format": "date-time" }, "expectedDeliveryDate": { "type": "string", "description": "The expected delivery date of the shipment.", "format": "date-time" }, "customerFirstName": { "type": "string", "description": "The customer's first name." }, "customerLastName": { "type": "string", "description": "The customer's last name." }, "shipmentGroupHeaderId": { "type": "string", "description": "The shipment group header id." }, "shipmentBatchHeaderId": { "type": "string", "description": "The shipment batch header id." }, "orderedDeliveryService": { "type": "string", "description": "The delivery service used for this shipment." }, "shipmentLines": { "type": "array", "description": "The list of shipment lines.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLine" } }, "packageHeaders": { "type": "array", "description": "The list of package headers.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentPackageHeader" } } }, "description": "The shipment header.", "xml": { "name": "partnerFulfillmentShipmentHeader" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderStatus": { "required": [ "code", "description", "name", "statusClassification" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment status.", "example": "PENDING_RELEASE" }, "name": { "type": "string", "description": "The short name for the shipment status.", "example": "Pending Release" }, "description": { "type": "string", "description": "The description of the shipment status.", "example": "The shipment is fully defined and is pending release to the Partner." }, "statusClassification": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderStatusClass" } }, "description": "The shipment header status.", "xml": { "name": "partnerFulfillmentShipmentHeaderStatus" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderStatusClass": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment status classification.", "example": "READY_TO_FULFILL" }, "name": { "type": "string", "description": "The short name for the shipment status classification.", "example": "Ready to Fulfill" }, "description": { "type": "string", "description": "The description of the shipment status classification.", "example": "The shipment is ready to be fulfilled." } }, "description": "The shipment header status classification.", "xml": { "name": "partnerFulfillmentShipmentHeaderStatusClass" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLine": { "required": [ "lineNumber", "orderRef", "quantity", "receiptQuantity", "receivableQuantity", "shipmentLineId", "skuNumber", "styleNumber", "totalAmount" ], "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "The UUID of the shipment line." }, "serviceLines": { "type": "array", "description": "The list of service charges", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_ServiceLine" } }, "lineNumber": { "type": "integer", "description": "The line number.", "format": "int32" }, "orderRef": { "type": "integer", "description": "The order ref of the linked order.", "format": "int32" }, "skuNumber": { "type": "string", "description": "The SKU number." }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number." }, "skuSize": { "type": "string", "description": "The size of the SKU." }, "styleNumber": { "type": "string", "description": "The style number." }, "supplierStyleNumber": { "type": "string", "description": "The supplier style number." }, "styleImageUrl": { "type": "string", "description": "The image URL of the style." }, "styleTitleDescription": { "type": "string", "description": "The title description of the style." }, "quantity": { "type": "integer", "description": "The quantity ordered of the SKU.", "format": "int32" }, "receiptQuantity": { "type": "integer", "description": "The Sum of Non-Cancelled Receipt Line Quantity.", "format": "int32" }, "receivableQuantity": { "type": "integer", "description": "Quantity which may be Received.", "format": "int32" }, "totalAmount": { "type": "number", "description": "The total amount.", "format": "double" } }, "description": "A shipment line.", "xml": { "name": "partnerFulfillmentShipmentLine" } }, "PartnerFulfillmentShipmentService_ServiceLine": { "type": "object", "properties": { "serviceLineNumber": { "type": "integer", "description": "The service line number", "format": "int32" }, "serviceTypeCode": { "type": "string", "description": "The service type code" }, "serviceSkuNumber": { "type": "string", "description": "The service sku number" }, "serviceTypeName": { "type": "string", "description": "The service type name" }, "serviceTypeDescription": { "type": "string", "description": "The service type description" } }, "description": "The list of service charges", "xml": { "name": "serviceLine" } }, "PartnerFulfillmentPackageDimensions": { "type": "object", "properties": { "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "packageDimensionsUnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasure" } }, "description": "The package dimensions" }, "PartnerFulfillmentPackageWeight": { "type": "object", "properties": { "weight": { "type": "number", "format": "double" }, "packageWeightUnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasure" } }, "description": "The package weight" }, "PartnerFulfillmentShipmentService_DeliveryServiceOrderLineStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The delivery service order line code" }, "name": { "type": "string", "description": "The delivery service order line name" }, "description": { "type": "string", "description": "The delivery service order line description" } }, "description": "The delivery service order line status", "xml": { "name": "deliveryServiceOrderLineStatus" } }, "PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentHeaderDetailsResponse": { "required": [ "shipmentHeaderDetails" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderDetails": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderDetails" } }, "xml": { "name": "getPartnerFulfillmentShipmentHeaderDetailsResponse" } }, "PartnerFulfillmentShipmentService_PartnerDeliveryServiceOrderLineDetail": { "required": [ "deliveryServiceOrderLineId", "deliveryServiceOrderLineStatus" ], "type": "object", "properties": { "deliveryServiceOrderLineId": { "type": "string", "description": "The unique ID of the delivery service order line" }, "deliveryServiceOrderHeaderId": { "type": "string", "description": "The unique Id of the delivery service order header" }, "deliveryServiceOrderLineNumber": { "type": "string", "description": "The delivery service order line number" }, "deliveryServiceOrderLineStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_DeliveryServiceOrderLineStatus" }, "partnerFulfillmentDeliveryService": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentDeliveryService" }, "partnerFulfillmentDeliveryServiceFees": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentDeliveryServiceFees" } }, "description": "The details of a service line", "xml": { "name": "partnerDeliveryServiceOrderLineDetail" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentAdditionalService": { "required": [ "code", "description", "name", "serviceFee" ], "type": "object", "properties": { "serviceFee": { "type": "number", "description": "The additional service fee" }, "code": { "type": "string", "description": "The additional service code" }, "name": { "type": "string", "description": "The additional service name" }, "description": { "type": "string", "description": "The additional service description" } }, "description": "The additional service details", "xml": { "name": "partnerFulfillmentAdditionalService" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentCarrier": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The carrier code" }, "name": { "type": "string", "description": "The carrier name" }, "description": { "type": "string", "description": "The carrier description" } }, "description": "The carrier info", "xml": { "name": "partnerFulfillmentCarrier" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentDeliveryService": { "required": [ "partnerFulfillmentCarrier", "partnerFulfillmentService" ], "type": "object", "properties": { "partnerFulfillmentCarrier": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentCarrier" }, "partnerFulfillmentService": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentService" }, "postageFee": { "type": "number", "description": "The postage fee for the delivery service" }, "packageLabelUuid": { "type": "string", "description": "The unique ID of the package label" }, "trackingNumber": { "type": "string", "description": "The tracking number of the package label" }, "averageTransitTime": { "type": "string", "description": "The average transit time" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date of the package.", "format": "date-time" }, "additionalServiceList": { "type": "array", "description": "The additional services.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentAdditionalService" } } }, "description": "The delivery service details", "xml": { "name": "partnerFulfillmentDeliveryService" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentDeliveryServiceFees": { "type": "object", "properties": { "postageFees": { "type": "number", "description": "The base postage fees." }, "additionalServiceFees": { "type": "number", "description": "The additional service fees." }, "totalFees": { "type": "number", "description": "The total service fees." }, "currencyCode": { "type": "string", "description": "The currency code for the fees." } }, "description": "The fees for a delivery service.", "xml": { "name": "partnerFulfillmentDeliveryServiceFees" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentService": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The service code" }, "name": { "type": "string", "description": "The service name" }, "description": { "type": "string", "description": "The service description" } }, "description": "The service info", "xml": { "name": "partnerFulfillmentService" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderDetails": { "required": [ "customerFirstName", "customerId", "customerLastName", "customerShipAddressInformation", "originSiteId", "returnSiteId", "shipmentBatchHeaderId", "shipmentGroupHeaderId", "shipmentHeaderId", "shipmentNumber", "shipmentStatus" ], "type": "object", "properties": { "shipmentHeaderId": { "type": "string", "description": "The UUID of the shipment." }, "shipmentNumber": { "type": "string", "description": "The shipment number." }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentHeaderStatus" }, "customerId": { "type": "string", "description": "The UUID of the customer." }, "customerFirstName": { "type": "string", "description": "The customer's first name." }, "customerLastName": { "type": "string", "description": "The customer's last name." }, "originSiteId": { "type": "string", "description": "The site UUID of the origin of the shipment." }, "returnSiteId": { "type": "string", "description": "The UUID of the return site of the shipment." }, "totalValue": { "type": "number", "description": "The total value of all orders in the shipment.", "format": "double" }, "totalOrderCount": { "type": "integer", "description": "The number of order refs in the shipment.", "format": "int32" }, "totalShipmentLineCount": { "type": "integer", "description": "The number of lines in this shipment.", "format": "int32" }, "totalShipmentLineQuantity": { "type": "integer", "description": "The total unit quantity for all lines in this shipment.", "format": "int32" }, "receiptQuantity": { "type": "integer", "description": "Sum of Non-Cancelled Receipt Line Quantity for the Shipment Header.", "format": "int32" }, "receivableQuantity": { "type": "integer", "description": "Quantity which may be Received for the Shipment Header.", "format": "int32" }, "minOrderDate": { "type": "string", "description": "The minimum date across all orders in this shipment.", "format": "date-time" }, "expectedDeliveryDate": { "type": "string", "description": "The expected delivery date of the shipment.", "format": "date-time" }, "shipDate": { "type": "string", "description": "The ship date of the shipment.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date of the shipment.", "format": "date-time" }, "deliveryDate": { "type": "string", "description": "The delivery date of the shipment.", "format": "date-time" }, "orderedDeliveryService": { "type": "string", "description": "The delivery service used for this shipment." }, "packages": { "type": "array", "description": "The packages of the shipment.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentPackageInfo" } }, "shipmentDeliveryServiceFees": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentDeliveryServiceFees" }, "customerShipAddressInformation": { "$ref": "#/components/schemas/PartnerFulfillmentService_CustomerShipAddressInformation" }, "shipmentGroupHeaderId": { "type": "string", "description": "The shipment group header id." }, "shipmentBatchHeaderId": { "type": "string", "description": "The shipment batch header id." } }, "description": "The shipment header, returned by GET Partner Header Details.", "xml": { "name": "partnerFulfillmentShipmentHeaderDetails" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentPackageInfo": { "required": [ "packageHeaderId", "packageName", "packageNumber", "packageRank" ], "type": "object", "properties": { "packageHeaderId": { "type": "string", "description": "The unique ID of the package" }, "packageRank": { "type": "integer", "description": "The position order of the package within the shipment", "format": "int32" }, "packageName": { "type": "string", "description": "The name of the package" }, "packageNumber": { "type": "string", "description": "The number of the package" }, "partnerFulfillmentPackageDimensions": { "$ref": "#/components/schemas/PartnerFulfillmentPackageDimensions" }, "partnerFulfillmentPackageWeight": { "$ref": "#/components/schemas/PartnerFulfillmentPackageWeight" }, "deliveryServiceOrderLines": { "type": "array", "description": "The delivery service lines of the package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerDeliveryServiceOrderLineDetail" } } }, "description": "The package info for a shipment's package", "xml": { "name": "partnerFulfillmentShipmentPackageInfo" } }, "UnitOfMeasure": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "abbreviation": { "type": "string" }, "baseQuantityCode": { "type": "string" }, "baseQuantityName": { "type": "string" } } }, "PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentLinesResponse": { "required": [ "currencyCode", "shipmentNumber", "shipmentUuid", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentUuid": { "type": "string", "description": "The unique UUID of the shipment header" }, "shipmentNumber": { "type": "string", "description": "The shipment number." }, "currencyCode": { "type": "string", "description": "The currency code use by all values in the response." }, "totalListCount": { "type": "integer", "description": "The total number of available shipment line groups to page through.", "format": "int32" }, "shipmentLineGroups": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLineGroup" } } }, "xml": { "name": "getPartnerFulfillmentShipmentLinesResponse" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLineGroup": { "required": [ "orderDate", "orderEstimatedDeliveryDate", "orderNumber", "orderStatus" ], "type": "object", "properties": { "orderNumber": { "type": "integer", "description": "The order number (order ref).", "format": "int32" }, "orderDate": { "type": "string", "description": "The order date and time.", "format": "date-time" }, "orderStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentOrderStatus" }, "orderEstimatedDeliveryDate": { "type": "string", "description": "The order estimated delivery date.", "format": "date-time" }, "shipmentLines": { "type": "array", "description": "The shipment lines in this order ref.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLines" } } }, "description": "A shipment line group.", "xml": { "name": "partnerFulfillmentShipmentLineGroup" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLines": { "required": [ "lineNumber", "orderLineId", "orderLineStatus", "quantity", "receiptQuantity", "receivableQuantity", "shipmentLineUuid", "skuNumber" ], "type": "object", "properties": { "shipmentLineUuid": { "type": "string", "description": "The UUID of the shipment line." }, "lineNumber": { "type": "integer", "description": "The line number.", "format": "int32" }, "orderLineId": { "type": "integer", "description": "The order line ID.", "format": "int32" }, "orderLineStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentOrderStatus" }, "expectedDeliveryDate": { "type": "string", "description": "The expected SLA date for this shipment line.", "format": "date-time" }, "skuNumber": { "type": "string", "description": "The SKU number." }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number." }, "skuSize": { "type": "string", "description": "The size of the SKU." }, "styleImageUrl": { "type": "string", "description": "The image URL of the style." }, "styleTitleDescription": { "type": "string", "description": "The title description of the style." }, "quantity": { "type": "integer", "description": "The quantity ordered of the SKU.", "format": "int32" }, "receiptQuantity": { "type": "integer", "description": "The Sum of Non-Cancelled Receipt Line Quantity.", "format": "int32" }, "receivableQuantity": { "type": "integer", "description": "Quantity which may be Received.", "format": "int32" }, "totalAmount": { "type": "number", "format": "double" }, "serviceLines": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentServiceLine" } } }, "description": "A shipment line and its service lines.", "xml": { "name": "partnerFulfillmentShipmentLines" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentOrderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order status.", "example": "PENDING_PAYMENT" }, "name": { "type": "string", "description": "The short name for the order status.", "example": "Pending Payment" }, "description": { "type": "string", "description": "The description of the order status.", "example": "The order is pending payment authorization and verification." } }, "description": "The customer order status.", "xml": { "name": "partnerFulfillmentShipmentOrderStatus" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentServiceLine": { "required": [ "serviceLineNumber", "serviceTotalAmount", "serviceTypeCode", "serviceTypeDescription", "serviceTypeName" ], "type": "object", "properties": { "serviceLineNumber": { "type": "integer", "description": "The line number of the service.", "format": "int32" }, "serviceTypeCode": { "type": "string", "description": "The service type code." }, "serviceTypeName": { "type": "string", "description": "The service type name." }, "serviceTypeDescription": { "type": "string", "description": "The service type description." }, "serviceTotalAmount": { "type": "number", "description": "The cost of the service.", "format": "double" } }, "description": "A service line.", "xml": { "name": "partnerFulfillmentShipmentServiceLine" } }, "PartnerFulfillmentShipmentService_GetPartnerFulfillmentShipmentLineResponse": { "required": [ "fulfillmentShipmentLine" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "fulfillmentShipmentLine": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentLine" } }, "xml": { "name": "getPartnerFulfillmentShipmentLineResponse" } }, "PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "fulfillmentShipmentLineIds": { "type": "array", "description": "List of uuids of deleted fulfillment shipment lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of deleted fulfillment shipment lines", "xml": { "name": "fulfillmentShipmentLineId" } } } }, "xml": { "name": "deletePartnerFulfillmentShipmentLinesResponse" } }, "PartnerFulfillmentShipmentService_DeletePartnerFulfillmentShipmentLinesRequest": { "required": [ "shipmentLineIds" ], "type": "object", "properties": { "shipmentLineIds": { "type": "array", "description": "The unique identifiers of the shipment lines to be deleted", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the shipment lines to be deleted", "xml": { "name": "shipmentLineId" } } } }, "xml": { "name": "deletePartnerFulfillmentShipmentLinesRequest" } }, "PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentLinesResponse": { "required": [ "shipmentHeaderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderUuid": { "type": "string", "description": "The unique code representing an existing fulfillment shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentLineUuids": { "type": "array", "description": "List of uuids of created fulfillment shipment lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of created fulfillment shipment lines", "xml": { "name": "shipmentLineUuid" } } } }, "xml": { "name": "createPartnerFulfillmentShipmentLinesResponse" } }, "PartnerFulfillmentShipmentService_CreatePartnerFulfillmentShipmentLinesRequest": { "required": [ "orderLineIds" ], "type": "object", "properties": { "orderLineIds": { "type": "array", "description": "The identifiers of the acntv order lines ids to create shipment lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The identifiers of the acntv order lines ids to create shipment lines", "xml": { "name": "orderLineId" } } } }, "xml": { "name": "createPartnerFulfillmentShipmentLinesRequest" } }, "PartnerFulfillmentShipmentService_GetSellerFulfilledShipmentsSummaryResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "sellerFulfilledShipmentsSummary": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_SellerFulfilledShipmentsSummary" } }, "xml": { "name": "getSellerFulfilledShipmentsSummaryResponse" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentStatusClassSummary": { "required": [ "code", "description", "displayOrder", "name", "statusClassCount" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment status classification.", "example": "READY_TO_FULFILL" }, "name": { "type": "string", "description": "The short name for the shipment status classification.", "example": "Ready to Fulfill" }, "description": { "type": "string", "description": "The description of the shipment status classification.", "example": "The shipment is ready to be fulfilled." }, "statusClassCount": { "type": "integer", "description": "Count of this Class Status", "format": "int32" }, "displayOrder": { "type": "integer", "description": "Display Order of this Class Status", "format": "int32" }, "shipmentStatusList": { "type": "array", "description": "The summary list of shipments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentStatusSummary" } } }, "description": "The shipment status class summary.", "xml": { "name": "PartnerFulfillmentShipmentStatusClassSummary" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentStatusSummary": { "required": [ "code", "description", "displayOrder", "name", "statusCount" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment status.", "example": "PENDING_RELEASE" }, "name": { "type": "string", "description": "The short name for the shipment status.", "example": "Pending Release" }, "description": { "type": "string", "description": "The description of the shipment status.", "example": "The shipment is fully defined and is pending release to the Partner." }, "statusCount": { "type": "integer", "description": "The count of shipment status.", "format": "int32", "example": 5 }, "displayOrder": { "type": "integer", "description": "The display order of shipment status.", "format": "int32", "example": 5 } }, "description": "The shipment status summary.", "xml": { "name": "partnerFulfillmentShipmentStatusSummary" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentTimePeriodSummary": { "required": [ "code", "description", "displayOrder", "name", "timePeriodCount" ], "type": "object", "properties": { "timePeriodCount": { "type": "integer", "description": "Count of items in this time period", "format": "int32" }, "displayOrder": { "type": "integer", "description": "Display Order of this time period", "format": "int32" }, "code": { "type": "string", "description": "The unique code representing the time period.", "example": "TODAY" }, "name": { "type": "string", "description": "The short name for the time period.", "example": "Today" }, "description": { "type": "string", "description": "The description for the time period.", "example": "Shipped Today" }, "shipmentStatusList": { "type": "array", "description": "The summary list of shipments", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentStatusSummary" } } }, "description": "The shipment time period summary.", "xml": { "name": "PartnerFulfillmentShipmentTimePeriodSummary" } }, "PartnerFulfillmentShipmentService_SellerFulfilledCurrentShipmentsSummary": { "type": "object", "properties": { "partnerUuid": { "type": "string", "description": "The UUID of the partner.", "xml": { "name": "shipmentHeaderId" } }, "shipmentStatusClassList": { "type": "array", "description": "The list of shipment status class summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentStatusClassSummary" } } }, "description": "The current shipments status summary.", "xml": { "name": "sellerFulfilledCurrentShipmentsSummary" } }, "PartnerFulfillmentShipmentService_SellerFulfilledRecentlyFulfilledShipmentsSummary": { "type": "object", "properties": { "partnerUuid": { "type": "string", "description": "The UUID of the partner.", "xml": { "name": "shipmentHeaderId" } }, "timePeriodList": { "type": "array", "description": "The list of shipment status class summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentTimePeriodSummary" } } }, "description": "The recently fulfilled shipments summary.", "xml": { "name": "SellerFulfilledRecentlyFulfilledShipmentsSummary" } }, "PartnerFulfillmentShipmentService_SellerFulfilledShipmentsSummary": { "type": "object", "properties": { "partnerUuid": { "type": "string", "description": "The UUID of the partner.", "xml": { "name": "shipmentHeaderId" } }, "sellerFulfilledCurrentShipmentsSummary": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_SellerFulfilledCurrentShipmentsSummary" }, "sellerFulfilledRecentlyFulfilledShipmentsSummary": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_SellerFulfilledRecentlyFulfilledShipmentsSummary" } }, "description": "The seller fulfilled shipments summary.", "xml": { "name": "SellerFulfilledShipmentsSummary" } }, "PartnerFulfillmentShipmentBatchService_CreateShipmentBatchHeaderResponse": { "required": [ "shipmentBatchId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentBatchId": { "type": "string", "description": "The unique code representing the shipment batch header created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createShipmentBatchHeaderResponse" } }, "PartnerFulfillmentShipmentBatchService_CreateShipmentBatchHeaderRequest": { "required": [ "shipmentBatchTypeCode" ], "type": "object", "properties": { "shipmentBatchTypeCode": { "pattern": "CUSTOM_SHIPMENT_LIST|PARAMETER_CONFIGURATION", "type": "string", "description": "The shipment batch type code" }, "shipmentHeaderIdList": { "type": "array", "description": "The list of shipment header unique identifiers", "items": { "type": "string", "description": "The list of shipment header unique identifiers", "xml": { "name": "shipmentHeaderIdList" } } }, "shipmentBatchParameter": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentBatchParameter" } }, "xml": { "name": "createShipmentBatchHeaderRequest" } }, "PartnerFulfillmentShipmentBatchService_ShipmentBatchParameter": { "type": "object", "properties": { "maxShipmentCount": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "The maximum shipment count for the shipment batch", "format": "int32" }, "maxShipmentGroupCount": { "maximum": 200, "minimum": 1, "type": "integer", "description": "The maximum shipment group count for the shipment batch", "format": "int32" }, "maxSkuCount": { "maximum": 2000, "minimum": 1, "type": "integer", "description": "The maximum SKU count for the shipment batch", "format": "int32" } }, "description": "Shipment Batch Parameter", "xml": { "name": "shipmentBatchParameter" } }, "PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeadersResponse": { "required": [ "filteredListCount", "shipmentBatchHeaders", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalListCount": { "type": "integer", "description": "A count of the total partner shipment batch headers available for the partner", "format": "int32", "xml": { "wrapped": true } }, "filteredListCount": { "type": "integer", "description": "A count of the total partner shipment batch headers returned", "format": "int32", "xml": { "wrapped": true } }, "shipmentBatchHeaders": { "type": "array", "description": "A list of partner shipment batch headers", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_PartnerFulfillmentShipmentBatchHeader" } } }, "xml": { "name": "getShipmentBatchHeadersResponse" } }, "PartnerFulfillmentShipmentBatchService_PartnerFulfillmentShipmentBatchHeader": { "required": [ "shipmentBatchHeaderNumber", "shipmentBatchHeaderSummary" ], "type": "object", "properties": { "shipmentBatchHeaderId": { "type": "string", "description": "The shipment batch header id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentBatchHeaderNumber": { "type": "string", "description": "Shipment Batch Display Number", "example": "SB5QM032RK3G" }, "shipmentBatchHeaderCreateDateTime": { "type": "string", "description": "The shipment batch header creation date.", "format": "date-time", "example": "2021-01-10T12:26:21-04:00" }, "shipmentBatchHeaderStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderStatus" }, "shipmentBatchHeaderSummary": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderSummary" }, "shipmentBatchCreatedUser": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_User" } }, "description": "Partner Fulfillment Shipment Batch Header", "xml": { "name": "partnerFulfillmentShipmentBatchHeader" } }, "PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderStatus": { "required": [ "code", "description", "displayOrder", "name", "shipmentBatchHeaderStatusClass" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment batch header status.", "example": "IN_PROGRESS" }, "name": { "type": "string", "description": "The short name for the shipment batch header status.", "example": "In Progress" }, "description": { "type": "string", "description": "The description of the shipment batch header status.", "example": "The shipment batch is in progress." }, "displayOrder": { "type": "integer", "description": "The display order of this shipment batch header status.", "format": "int32", "example": 1 }, "shipmentBatchHeaderStatusClass": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderStatusClass" } }, "description": "Partner Shipment Batch Header Status", "xml": { "name": "shipmentBatchHeaderStatus" } }, "PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderStatusClass": { "required": [ "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the classification of the shipment batch header status.", "example": "INCOMPLETE" }, "name": { "type": "string", "description": "The short name for the classification of the shipment batch header status.", "example": "Incomplete" }, "description": { "type": "string", "description": "The description of the classification of the shipment batch header status.", "example": "The shipment batch is incomplete" }, "displayOrder": { "type": "integer", "description": "The display order of this shipment batch header status classification.", "format": "int32", "example": 1 } }, "description": "Partner Shipment Batch Header Status Classification", "xml": { "name": "shipmentBatchHeaderStatusClass" } }, "PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderSummary": { "type": "object", "properties": { "shipmentGroupHeaderCount": { "type": "integer", "description": "Shipment Batch Group Header Count", "format": "int32", "example": 5 }, "shipmentHeaderCount": { "type": "integer", "description": "Shipment Batch Shipment Header Count", "format": "int32", "example": 10 }, "skuCount": { "type": "integer", "description": "Shipment Batch SKU Count", "format": "int32", "example": 30 }, "skuQuantity": { "type": "integer", "description": "Shipment Batch SKU quantity", "format": "int32", "example": 50 } }, "description": "Partner Shipment Batch Header Summary", "xml": { "name": "shipmentBatchHeaderSummary" } }, "PartnerFulfillmentShipmentBatchService_User": { "type": "object", "properties": { "firstName": { "type": "string", "description": "User First Name", "example": "Holly" }, "lastName": { "type": "string", "description": "User Last Name", "example": "Golightly" }, "username": { "type": "string", "description": "Username", "example": "hollly.golightly@jtv.com" }, "uuid": { "type": "string", "description": "User ID", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "userId" } } }, "description": "Partner Shipment Batch Header User" }, "PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeaderResponse": { "required": [ "shipmentBatchHeader" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentBatchHeader": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_PartnerFulfillmentShipmentBatchHeader" } }, "xml": { "name": "getShipmentBatchHeaderResponse" } }, "PartnerFulfillmentShipmentBatchService_GetShipmentBatchHeaderPreviewResponse": { "required": [ "shipmentBatchHeaderSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentBatchHeaderSummary": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentBatchHeaderSummary" } }, "xml": { "name": "getShipmentBatchHeaderPreviewResponse" } }, "PartnerFulfillmentShipmentBatchService_GetShipmentGroupHeadersResponse": { "required": [ "filteredListCount", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalListCount": { "type": "integer", "description": "The shipment group header list count", "format": "int32" }, "filteredListCount": { "type": "integer", "description": "The shipment group header filtered list count", "format": "int32" }, "shipmentGroupHeaders": { "type": "array", "description": "A list of shipment group headers", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentGroupHeader" } } }, "xml": { "name": "getShipmentGroupHeadersResponse" } }, "PartnerFulfillmentShipmentBatchService_ShipmentGroupHeader": { "type": "object", "properties": { "shipmentGroupHeaderId": { "type": "string", "description": "The shipment group header's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentBatchHeaderId": { "type": "string", "description": "The shipment batch header's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentGroupHeaderNumber": { "type": "string", "description": "The shipment group header number", "example": "SCPPALWCRU-001" }, "shipmentGroupHeaderStatus": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentGroupHeaderStatus" }, "shipmentGroupHeaderCreateDateTime": { "type": "string", "description": "The shipment group create date.", "format": "date-time" }, "shipmentGroupCreatedUser": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_User" }, "shipmentGroupLastUpdatedUser": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_User" }, "shipmentSummary": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentGroupSummaryInformation" }, "shipmentGroupLines": { "type": "array", "description": "The shipment group lines.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_ShipmentGroupLine" } } }, "description": "Shipment group header", "xml": { "name": "shipmentGroupHeader" } }, "PartnerFulfillmentShipmentBatchService_ShipmentGroupSummaryInformation": { "type": "object", "properties": { "shipmentGroupValue": { "type": "number", "description": "The shipment group total dollar value", "format": "double", "example": 95.99 }, "shipmentHeaderCount": { "type": "integer", "description": "The shipment header count", "format": "int32", "example": 2 }, "skuCount": { "type": "integer", "description": "The distinct sku count", "format": "int32", "example": 10 }, "skuQuantity": { "type": "integer", "description": "The distinct sku count", "format": "int32", "example": 10 } }, "description": "Shipment group summary information", "xml": { "name": "shipmentGroupSummaryInformation" } }, "PartnerFulfillmentShipmentService_PartnerFulfillmentShipmentGroupHeaderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the shipment group status.", "example": "READY_TO_PICK" }, "name": { "type": "string", "description": "The short name for the shipment group status.", "example": "Ready to Pick" }, "description": { "type": "string", "description": "The description for the shipment group status.", "example": "The shipment group has been created and is ready to pick the SKUs needed to fulfill the associated shipments." } }, "description": "The shipment group header status.", "xml": { "name": "partnerFulfillmentShipmentGroupHeaderStatus" } }, "PartnerFulfillmentShipmentService_ShipmentGroupLine": { "required": [ "quantity", "shipmentGroupLineId", "shipmentGroupLineNumber", "skuNumber", "styleNumber" ], "type": "object", "properties": { "shipmentGroupLineId": { "type": "string", "description": "The UUID of the shipment group line." }, "shipmentGroupLineNumber": { "type": "integer", "description": "The shipment group line number.", "format": "int32" }, "styleNumber": { "type": "string", "description": "The style number." }, "supplierStyleNumber": { "type": "string", "description": "The supplier style number." }, "styleTitleDescription": { "type": "string", "description": "The title description of the style." }, "styleImageUrl": { "type": "string", "description": "The image URL of the style." }, "skuNumber": { "type": "string", "description": "The SKU number." }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number." }, "skuSize": { "type": "string", "description": "The size of the SKU." }, "quantity": { "type": "integer", "description": "The quantity ordered of the SKU.", "format": "int32" }, "basePrice": { "type": "number", "description": "The current base selling price for the SKU.", "format": "double" }, "serviceLines": { "type": "array", "description": "The list of service charges", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentService_ServiceLine" } } }, "description": "A shipment group line.", "xml": { "name": "shipmentGroupLine" } }, "PartnerFulfillmentShipmentBatchService_GetShipmentGroupHeaderResponse": { "required": [ "shipmentGroupHeader" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentGroupHeader": { "$ref": "#/components/schemas/PartnerFulfillmentShipmentBatchService_ShipmentGroupHeader" } }, "xml": { "name": "getShipmentGroupHeaderResponse" } }, "PartnerFulfillmentShipmentBatchService_UpdateShipmentGroupHeaderStatusResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updateShipmentGroupHeaderStatusResponse" } }, "PartnerFulfillmentShipmentBatchService_UpdateShipmentGroupHeaderStatusRequest": { "required": [ "shipmentGroupHeaderStatusCode" ], "type": "object", "properties": { "shipmentGroupHeaderStatusCode": { "type": "string", "description": "The shipment header group status code", "example": "READY_TO_PACK" } }, "xml": { "name": "updateShipmentGroupHeaderStatusRequest" } }, "PartnerFulfillmentShippingSettingsService_FulfillmentLeadTime": { "type": "object", "properties": { "code": { "type": "string", "description": "Fulfillment Lead Time Code" }, "name": { "type": "string", "description": "Fulfillment Lead Time Name" }, "description": { "type": "string", "description": "Fulfillment Lead Time Description" }, "value": { "type": "string", "description": "Fulfillment Lead Time Value" }, "unitOfMeasure": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UnitOfMeasure" } }, "description": "The partner's style preferences for fulfillment lead time.", "xml": { "name": "fulfillmentLeadTime" } }, "PartnerFulfillmentShippingSettingsService_GetPartnerFulfillmentShippingSettingsListResponse": { "required": [ "partnerFulfillmentShippingSettings" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerFulfillmentShippingSettings": { "type": "array", "description": "Partner fulfillment shipping settings for a partner", "xml": { "name": "partnerFulfillmentShippingSettingsList", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_PartnerFulfillmentShippingSettings" } } }, "xml": { "name": "getPartnerFulfillmentShippingSettingsListResponse" } }, "PartnerFulfillmentShippingSettingsService_PackageLabelType": { "type": "object", "properties": { "code": { "type": "string", "description": "Package Label Type Code" }, "name": { "type": "string", "description": "Package Label Type Name" }, "description": { "type": "string", "description": "Package Label Type Description" } }, "description": "The partner's preferences for this type.", "xml": { "name": "packageLabelType" } }, "PartnerFulfillmentShippingSettingsService_PartnerFulfillmentShippingSettings": { "required": [ "includePackageLabelOrderInfo" ], "type": "object", "properties": { "shippingSettingsId": { "type": "string", "description": "Id of the shipping settings profile." }, "dimensionsUom": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UnitOfMeasure" }, "weightUomType": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_PrefWeightUomType" }, "weightUom": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_UnitOfMeasure" }, "packageLabelType": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_PackageLabelType" }, "includePackageLabelOrderInfo": { "type": "boolean", "description": "A flag indicating whether or not the package label order information should be included.", "example": true }, "fulfillmentLeadTime": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_FulfillmentLeadTime" } }, "description": "Partner fulfillment shipping settings for a partner", "xml": { "name": "partnerFulfillmentShippingSettings" } }, "PartnerFulfillmentShippingSettingsService_PrefWeightUomType": { "type": "object", "properties": { "code": { "type": "string", "description": "Pref Weight Uom Type Code" }, "name": { "type": "string", "description": "Pref Weight Uom Type Name" }, "description": { "type": "string", "description": "Pref Weight Uom Type Description" } }, "description": "The partner's preferences for this type.", "xml": { "name": "prefWeightUomType" } }, "PartnerFulfillmentShippingSettingsService_UnitOfMeasure": { "type": "object", "properties": { "code": { "type": "string", "description": "Unit of Measure Code" }, "name": { "type": "string", "description": "Unit of Measure Name" }, "description": { "type": "string", "description": "Unit of Measure Description" } }, "description": "The unit of measure for fulfillment lead time.", "xml": { "name": "unitOfMeasure" } }, "PartnerFulfillmentShippingSettingsService_GetPartnerFulfillmentShippingSettingsResponse": { "required": [ "partnerFulfillmentShippingSettings" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerFulfillmentShippingSettings": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_PartnerFulfillmentShippingSettings" } }, "xml": { "name": "getPartnerFulfillmentShippingSettingsResponse" } }, "PartnerFulfillmentShippingSettingsService_UpdatePartnerFulfillmentShippingSettingsResponse": { "required": [ "shippingSettingsUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shippingSettingsUuid": { "type": "string", "description": "The unique UUID of the shipping settings" } }, "xml": { "name": "updatePartnerFulfillmentShippingSettingsResponse" } }, "PartnerFulfillmentShippingSettingsService_UpdatePartnerFulfillmentShippingSettings": { "required": [ "dimensionsUomCode", "fulfillmentLeadTimeCode", "includePkgLblOrderInfo", "packageLabelTypeCode", "weightUomCode", "weightUomTypeCode" ], "type": "object", "properties": { "dimensionsUomCode": { "type": "string", "description": "Dimensions unit of measure code." }, "weightUomTypeCode": { "type": "string", "description": "Weight type unit of measure code." }, "weightUomCode": { "type": "string", "description": "Weight unit of measure code." }, "packageLabelTypeCode": { "type": "string", "description": "Package label type code." }, "includePkgLblOrderInfo": { "type": "boolean", "description": "Include package label order info flag." }, "fulfillmentLeadTimeCode": { "type": "string", "description": "Fulfillment lead time code." } }, "xml": { "name": "updatePartnerFulfillmentShippingSettings" } }, "PartnerStoreFulfillmentShippingSettingsService_GetPartnerStoreFulfillmentShippingSettingsListResponse": { "required": [ "partnerStoreFulfillmentShippingSettings" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerStoreFulfillmentShippingSettings": { "type": "array", "description": "Partner store fulfillment shipping settings for a partner", "xml": { "name": "partnerStoreFulfillmentShippingSettingsList", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_PartnerStoreFulfillmentShippingSettings" } } }, "xml": { "name": "getPartnerStoreFulfillmentShippingSettingsListResponse" } }, "PartnerStoreFulfillmentShippingSettingsService_PartnerStoreFulfillmentShippingSettings": { "type": "object", "properties": { "storeShippingSettingsId": { "type": "string", "description": "Id of the store shipping settings profile." }, "fulfillmentLeadTime": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_FulfillmentLeadTime" } }, "description": "Partner Store fulfillment shipping settings for a partner", "xml": { "name": "partnerStoreFulfillmentShippingSettings" } }, "PartnerStoreFulfillmentShippingSettingsService_GetPartnerStoreFulfillmentShippingSettingsResponse": { "required": [ "partnerStoreFulfillmentShippingSettings" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerStoreFulfillmentShippingSettings": { "$ref": "#/components/schemas/PartnerStoreFulfillmentShippingSettingsService_PartnerStoreFulfillmentShippingSettings" } }, "xml": { "name": "getPartnerStoreFulfillmentShippingSettingsResponse" } }, "PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettingsResponse": { "required": [ "styleShippingSettingsUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleShippingSettingsUuid": { "type": "string", "description": "The unique UUID of the style shipping settings" } }, "xml": { "name": "updatePartnerStyleFulfillmentShippingSettingsResponse" } }, "PartnerStoreFulfillmentShippingSettingsService_UpdatePartnerStoreFulfillmentShippingSettings": { "required": [ "fulfillmentLeadTimeCode" ], "type": "object", "properties": { "fulfillmentLeadTimeCode": { "type": "string", "description": "Fulfillment lead time code." } }, "xml": { "name": "updatePartnerStoreFulfillmentShippingSettings" } }, "PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettingsResponse": { "required": [ "styleShippingSettingsUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleShippingSettingsUuid": { "type": "string", "description": "The unique UUID of the style shipping settings" } }, "xml": { "name": "createPartnerStyleFulfillmentShippingSettingsResponse" } }, "PartnerStoreFulfillmentShippingSettingsService_CreatePartnerStoreFulfillmentShippingSettings": { "required": [ "fulfillmentLeadTimeCode" ], "type": "object", "properties": { "fulfillmentLeadTimeCode": { "type": "string", "description": "Fulfillment lead time code." } }, "xml": { "name": "createPartnerStoreFulfillmentShippingSettings" } }, "PartnerStyleFulfillmentShippingSettingsService_GetPartnerStyleFulfillmentShippingSettingsListResponse": { "required": [ "partnerStyleFulfillmentShippingSettings" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerStyleFulfillmentShippingSettings": { "type": "array", "description": "Partner style fulfillment shipping settings for a partner", "xml": { "name": "partnerStyleFulfillmentShippingSettingsList", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_PartnerStyleFulfillmentShippingSettings" } } }, "xml": { "name": "getPartnerStyleFulfillmentShippingSettingsListResponse" } }, "PartnerStyleFulfillmentShippingSettingsService_PartnerStyleFulfillmentShippingSettings": { "type": "object", "properties": { "styleShippingSettingsId": { "type": "string", "description": "Id of the style shipping settings profile." }, "fulfillmentLeadTime": { "$ref": "#/components/schemas/PartnerFulfillmentShippingSettingsService_FulfillmentLeadTime" } }, "description": "Partner Style fulfillment shipping settings for a partner", "xml": { "name": "partnerStyleFulfillmentShippingSettings" } }, "PartnerStyleFulfillmentShippingSettingsService_GetPartnerStyleFulfillmentShippingSettingsResponse": { "required": [ "partnerStyleFulfillmentShippingSettings" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerStyleFulfillmentShippingSettings": { "$ref": "#/components/schemas/PartnerStyleFulfillmentShippingSettingsService_PartnerStyleFulfillmentShippingSettings" } }, "xml": { "name": "getPartnerStyleFulfillmentShippingSettingsResponse" } }, "PartnerStyleFulfillmentShippingSettingsService_UpdatePartnerStyleFulfillmentShippingSettings": { "required": [ "fulfillmentLeadTimeCode" ], "type": "object", "properties": { "fulfillmentLeadTimeCode": { "type": "string", "description": "Fulfillment lead time code." } }, "xml": { "name": "updatePartnerStyleFulfillmentShippingSettings" } }, "PartnerStyleFulfillmentShippingSettingsService_CreatePartnerStyleFulfillmentShippingSettings": { "required": [ "fulfillmentLeadTimeCode" ], "type": "object", "properties": { "fulfillmentLeadTimeCode": { "type": "string", "description": "Fulfillment lead time code." } }, "xml": { "name": "createPartnerStyleFulfillmentShippingSettings" } }, "PartnerHyperwalletService_CreateHyperwalletAuthenticationTokenResponse": { "required": [ "authToken" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "authToken": { "type": "string", "description": "Hyperwallet Auth Token" } }, "xml": { "name": "createHyperwalletAuthenticationTokenResponse" } }, "PartnerHyperwalletService_GetPartnerHyperwalletUsersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "hyperwalletUsers": { "type": "array", "description": "The list of hyperwallet users associated with the partner", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerHyperwalletService_PartnerHyperwalletUser" } } }, "xml": { "name": "getPartnerHyperwalletUsersResponse" } }, "PartnerHyperwalletService_PartnerHyperwalletUser": { "type": "object", "properties": { "hyperwalletUserId": { "type": "string", "description": "The hyperwallet user's UUID", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "userToken": { "type": "string", "description": "The user token", "example": "usr-34ce-494d-b7da-d06b213583d6" }, "userVerificationStatus": { "$ref": "#/components/schemas/PartnerHyperwalletService_UserVerificationStatus" } }, "description": "The partner's hyperwallet user", "xml": { "name": "partnerHyperwalletUser" } }, "PartnerHyperwalletService_UserVerificationStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the transaction status.", "example": "POSTING" }, "name": { "type": "string", "description": "The short name for the transaction status.", "example": "Posting" }, "description": { "type": "string", "description": "The description of the transaction status.", "example": "The transaction is currently being posted" } }, "description": "The user verification status.", "example": "Pending", "xml": { "name": "userVerificationStatus" } }, "PartnerHyperwalletUserService_UpdateHyperwalletUserResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updateHyperwalletUserResponse" } }, "PartnerHyperwalletService_UpdateHyperwalletUser": { "required": [ "userVerificationStatus" ], "type": "object", "properties": { "userVerificationStatus": { "type": "string", "description": "The user verification status.", "example": "Pending" } }, "description": "The hyperwallet user for update", "xml": { "name": "updateHyperwalletUser" } }, "PartnerHyperwalletService_UpdateHyperwalletUserRequest": { "required": [ "updateHyperwalletUser" ], "type": "object", "properties": { "updateHyperwalletUser": { "$ref": "#/components/schemas/PartnerHyperwalletService_UpdateHyperwalletUser" } }, "xml": { "name": "updateHyperwalletUserRequest" } }, "PartnerHyperwalletService_CreateHyperwalletUserAuthenticationTokenResponse": { "required": [ "authToken" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "authToken": { "type": "string", "description": "Hyperwallet Auth Token" } }, "xml": { "name": "createHyperwalletUserAuthenticationTokenResponse" } }, "PartnerInstallmentBillingService_DeleteInstallmentBillingScheduleStatus": { "type": "object", "properties": { "installBillingScheduleId": { "type": "string", "description": "The unique id representing the installment billing schedule.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "errorResponse": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_ErrorResponse" } }, "description": "The installment billing schedules that was updated", "xml": { "name": "styleListing" } }, "PartnerInstallmentBillingService_ErrorResponse": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "200" }, "name": { "type": "string", "description": "The error description.", "example": "SUCCESS" }, "description": { "type": "string", "description": "The error description.", "example": "success" } }, "description": "The error response", "xml": { "name": "errorResponse" } }, "PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesResponse": { "required": [ "installmentBillingSchedules" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "installmentBillingSchedules": { "type": "array", "description": "The installment billing schedules that was updated", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_DeleteInstallmentBillingScheduleStatus" } } }, "xml": { "name": "updateInstallmentBillingSchedulesResponse" } }, "PartnerInstallmentBillingService_CreateInstallmentBillingSchedules": { "required": [ "styleListingIds" ], "type": "object", "properties": { "styleListingIds": { "type": "array", "description": "The list of unique id's representing the style listing.", "example": [ "889e6036-34ce-494d-b7da-d06b213583d6", "123e4567-e89b-12d3-a456-426614174000" ], "items": { "type": "string", "description": "The list of unique id's representing the style listing.", "example": "[\"889e6036-34ce-494d-b7da-d06b213583d6\",\"123e4567-e89b-12d3-a456-426614174000\"]", "xml": { "name": "styleListingIds" } } } }, "description": "The list of installment billing schedules to create.", "xml": { "name": "createInstallmentBillingSchedules" } }, "PartnerInstallmentBillingService_CreateInstallmentBillingSchedulesRequest": { "required": [ "createInstallmentBillingSchedules" ], "type": "object", "properties": { "createInstallmentBillingSchedules": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_CreateInstallmentBillingSchedules" } }, "xml": { "name": "createInstallmentBillingSchedulesRequest" } }, "PartnerInstallmentBillingService_UpdateInstallmentBillingSchedules": { "required": [ "endDateTime", "installmentBillingScheduleIds" ], "type": "object", "properties": { "installmentBillingScheduleIds": { "type": "array", "description": "The list of unique id's representing the installment billing schedule.", "example": [ "889e6036-34ce-494d-b7da-d06b213583d6", "123e4567-e89b-12d3-a456-426614174000" ], "items": { "type": "string", "description": "The list of unique id's representing the installment billing schedule.", "example": "[\"889e6036-34ce-494d-b7da-d06b213583d6\",\"123e4567-e89b-12d3-a456-426614174000\"]", "xml": { "name": "installmentBillingScheduleIds" } } }, "endDateTime": { "type": "string", "description": "The installment schedule end date time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The list of installment billing schedules.", "xml": { "name": "updateInstallmentBillingSchedules" } }, "PartnerInstallmentBillingService_UpdateInstallmentBillingSchedulesRequest": { "required": [ "updateInstallmentBillingSchedules" ], "type": "object", "properties": { "updateInstallmentBillingSchedules": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_UpdateInstallmentBillingSchedules" } }, "xml": { "name": "updateInstallmentBillingSchedulesRequest" } }, "PartnerInstallmentBillingService_GetInstallmentBillingSchedulesByStyleResponse": { "required": [ "filteredListCount", "installmentBillingSchedules", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "filteredListCount": { "type": "integer", "description": "A count of the total filtered installment billing schedules returned", "format": "int32" }, "totalListCount": { "type": "integer", "description": "A count of the total installment billing schedules for the style", "format": "int32" }, "styleListingId": { "type": "string", "description": "The uuid representing the style listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "styleNumber": { "type": "string", "description": "The style number of the style listing.", "example": "3361353" }, "basePrice": { "type": "number", "description": "The base price of the listing style.", "example": 50 }, "sellingPrice": { "type": "number", "description": "The selling price of the listing style.", "example": 45 }, "installmentBillingSchedules": { "type": "array", "description": "The installment billing schedules history for the given style", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingSchedule" } }, "errorResponse": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_ErrorResponse" } }, "xml": { "name": "getInstallmentBillingSchedulesByStyleResponse" } }, "PartnerInstallmentBillingService_InstallmentBillingSchedule": { "type": "object", "properties": { "installBillingScheduleId": { "type": "string", "description": "The unique id representing the installment billing schedule.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "installmentBillingTerms": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingTerms" }, "startDateTime": { "type": "string", "description": "The schedule start date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "endDateTime": { "type": "string", "description": "The schedule end date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "installBillingFeeEstimate": { "type": "number", "description": "Estimated Fees for JewelPay Installments based upon current Selling Price of the Style", "example": 5 }, "installmentBillingScheduleType": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingType" } }, "description": "The installment billing schedules history for the given style", "xml": { "name": "installmentBillingSchedule" } }, "PartnerInstallmentBillingService_InstallmentBillingTerms": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The error code.", "example": "200" }, "name": { "type": "string", "description": "The error description.", "example": "SUCCESS" }, "description": { "type": "string", "description": "The error description.", "example": "success" } }, "description": "The installment billing terms.", "xml": { "name": "installmentBillingTerms" } }, "PartnerInstallmentBillingService_InstallmentBillingType": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The installment billing type code.", "example": "PARTNER_ACTIVATION" }, "name": { "type": "string", "description": "The installment billing type name.", "example": "Partner Activation" }, "description": { "type": "string", "description": "The installment billing type description.", "example": "The JewelPay Installments offer was activated by a Partner." }, "displayOrder": { "type": "integer", "description": "The installment billing type display order.", "format": "int32", "example": 1 } }, "description": "The installment billing schedule type.", "xml": { "name": "installmentBillingType" } }, "PartnerInstallmentBillingService_GetInstallmentBillingScheduleDetailResponse": { "required": [ "installmentBillingScheduleDetail" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingId": { "type": "string", "description": "The uuid representing the style listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "styleNumber": { "type": "string", "description": "The style number of the style listing.", "example": "3361353" }, "basePrice": { "type": "number", "description": "The base price of the listing style.", "example": 50 }, "sellingPrice": { "type": "number", "description": "The selling price of the listing style.", "example": 45 }, "installmentBillingScheduleDetail": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingScheduleDetail" }, "errorResponse": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_ErrorResponse" } }, "xml": { "name": "getInstallmentBillingScheduleDetailResponse" } }, "PartnerInstallmentBillingService_InstallmentBillingScheduleDetail": { "type": "object", "properties": { "installBillingScheduleId": { "type": "string", "description": "The unique id representing the installment billing schedule.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "installmentBillingTerms": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingTerms" }, "startDateTime": { "type": "string", "description": "The schedule start date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "endDateTime": { "type": "string", "description": "The schedule end date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "installBillingFeeEstimate": { "type": "number", "description": "Estimated Fees for JewelPay Installments based upon current Selling Price of the Style", "example": 5 }, "installmentBillingScheduleType": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingType" }, "createdInfo": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingScheduleInfo" }, "lastUpdatedInfo": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingScheduleInfo" } }, "description": "The installment billing schedule detail", "xml": { "name": "installmentBillingScheduleDetail" } }, "PartnerInstallmentBillingService_InstallmentBillingScheduleInfo": { "type": "object", "properties": { "installBillingScheduleId": { "type": "string", "description": "The unique id representing the installment billing schedule.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "installmentBillingTerms": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingTerms" }, "startDateTime": { "type": "string", "description": "The schedule start date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "endDateTime": { "type": "string", "description": "The schedule end date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "installBillingFeeEstimate": { "type": "number", "description": "Estimated Fees for JewelPay Installments based upon current Selling Price of the Style", "example": 5 }, "installmentBillingScheduleType": { "$ref": "#/components/schemas/PartnerInstallmentBillingService_InstallmentBillingType" }, "dateTime": { "type": "string", "description": "The schedule info date time", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "userAccountId": { "type": "string", "description": "The unique id representing the user account.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "userName": { "type": "string", "description": "The user name.", "example": "Susan" }, "firstName": { "type": "string", "description": "The user first name.", "example": "Susan" }, "lastName": { "type": "string", "description": "The user last name.", "example": "Smith" } }, "description": "The installment billing schedules last updated info.", "xml": { "name": "installmentBillingScheduleInfo" } }, "PartnerInventoryService_UpdateDropShipInventoryResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updateDropShipInventoryResponse" } }, "PartnerInventoryService_SkuInventory": { "required": [ "quantity", "skuNumber" ], "type": "object", "properties": { "skuNumber": { "type": "string", "description": "The SKU product number", "example": "ABC1234-5" }, "quantity": { "maximum": 999999, "minimum": 0, "type": "integer", "description": "The available drop ship quantity for this SKU", "format": "int32", "example": 50 } }, "description": "The sku drop ship quantities to be updated", "xml": { "name": "skuInventory" } }, "PartnerInventoryService_UpdateDropShipInventoryRequest": { "required": [ "skuInventoryList" ], "type": "object", "properties": { "skuInventoryList": { "type": "array", "description": "The sku drop ship quantities to be updated", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerInventoryService_SkuInventory" } } }, "xml": { "name": "updateDropShipInventoryRequest" } }, "PartnerInventoryService_PartnerInventoryAdjustmentHistory": { "required": [ "skuInformationDetails", "skuInventoryDetails" ], "type": "object", "properties": { "skuInformationDetails": { "$ref": "#/components/schemas/PartnerInventoryService_SkuInformationDetails" }, "skuInventoryDetails": { "$ref": "#/components/schemas/PartnerInventoryService_SkuInventoryDetails" } }, "description": "Partner Inventory Adjustment History Representation", "xml": { "name": "partnerInventoryAdjustmentHistory" } }, "PartnerInventoryService_PartnerInventoryAdjustmentHistoryResponse": { "required": [ "partnerInventoryAdjustmentHistory" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerInventoryAdjustmentHistory": { "$ref": "#/components/schemas/PartnerInventoryService_PartnerInventoryAdjustmentHistory" } }, "xml": { "name": "partnerInventoryAdjustmentHistoryResponse" } }, "PartnerInventoryService_SkuInformationDetails": { "required": [ "skuProductId", "styleImageUrl", "styleNumber", "styleTitleDescription" ], "type": "object", "properties": { "skuProductId": { "type": "string", "description": "SKU product Id", "example": "12345" }, "styleNumber": { "type": "string", "description": "Style Number", "example": "12345-4" }, "styleImageUrl": { "type": "string", "description": "Style Image Url", "example": "/path/to/image/1234.png" }, "styleTitleDescription": { "type": "string", "description": "Style Title Desc", "example": "World Series Ring" }, "skuSize": { "type": "string", "description": "Sku Size", "example": "XL" }, "styleListingStatus": { "type": "string", "description": "Style Listing Status", "example": "ACTIVE" }, "supplierStyleNumber": { "type": "string", "description": "Supplier Style Number", "example": "12345" }, "supplierSkuNumber": { "type": "string", "description": "Supplier SKU Number", "example": "12345" } }, "description": "Sku Information Details", "xml": { "name": "skuInformationDetails" } }, "PartnerInventoryService_SkuInventoryDetails": { "required": [ "supplyDistributionCenterAvailable", "supplyDistributionCenterSold", "supplyDistributionCenterUnavailable", "supplyDropShipAvailable", "supplyDropShipOnHand", "supplyDropShipSold", "supplyDropShipUnavailable", "supplyTotalAvailableToPromise" ], "type": "object", "properties": { "supplyDistributionCenterAvailable": { "type": "integer", "description": "Supply Distribution Center Available", "format": "int32", "example": 50 }, "supplyDistributionCenterUnavailable": { "type": "integer", "description": "Supply Distribution Center Unavailable", "format": "int32", "example": 50 }, "supplyDistributionCenterSold": { "type": "integer", "description": "Supply Distribution Center Sold", "format": "int32", "example": 50 }, "supplyDropShipOnHand": { "type": "integer", "description": "Supply Drop Ship On Hand", "format": "int32", "example": 50 }, "supplyDropShipAvailable": { "type": "integer", "description": "Supply Drop Ship Available", "format": "int32", "example": 50 }, "supplyDropShipUnavailable": { "type": "integer", "description": "Supply Drop Ship Unavailable", "format": "int32", "example": 50 }, "supplyDropShipSold": { "type": "integer", "description": "Supply Drop Ship Sold", "format": "int32", "example": 50 }, "supplyTotalAvailableToPromise": { "type": "integer", "description": "Supply Total Available to Promise", "format": "int32", "example": 50 } }, "description": "Sku Inventory Details", "xml": { "name": "skuInventoryDetails" } }, "PartnerInventoryService_InventoryAdjustmentClass": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Classification Code", "example": "PARTNER_SUPPLY_ADJUSTMENT" }, "name": { "type": "string", "description": "Classification Name", "example": "Partner Supply Adjustment" }, "description": { "type": "string", "description": "Classification description", "example": "An inventory adjustment performed to edit the Partners supply." } }, "description": "Inventory Adjustment Classification", "xml": { "name": "inventoryAdjustmentClassification" } }, "PartnerInventoryService_InventoryAdjustmentFinancialTransaction": { "required": [ "transactionStatementUuid", "transactionStatus", "transactionTitleDescription", "transactionUuid" ], "type": "object", "properties": { "transactionUuid": { "type": "string", "description": "Transaction UUID", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "transactionId" } }, "transactionStatementUuid": { "type": "string", "description": "Statement UUID", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "transactionStatementId" } }, "transactionDateTime": { "type": "string", "description": "Transaction Date Time", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "transactionPostDateTime": { "type": "string", "description": "Transaction Post Date Time", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "transactionStatus": { "type": "string", "description": "Transaction Status Code", "example": "PENDING" }, "transactionTitleDescription": { "type": "string", "description": "Transaction Title Desc", "example": "Product Sale: Order #999999999-1" }, "transactionClassification": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentFinancialTransactionClass" }, "transactionAmount": { "type": "number", "description": "The transaction amount", "example": 23.52 } }, "description": "inventory Adjustment Financial Transaction List", "xml": { "name": "inventoryAdjustmentFinancialTransaction" } }, "PartnerInventoryService_InventoryAdjustmentFinancialTransactionCategory": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Category Code", "example": "SALES" }, "name": { "type": "string", "description": "Category Name", "example": "Sales" }, "description": { "type": "string", "description": "Category description", "example": "Sales Activity." } }, "description": "The transaction category", "xml": { "name": "inventoryAdjustmentFinancialTransactionCategory" } }, "PartnerInventoryService_InventoryAdjustmentFinancialTransactionClass": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Classification Code", "example": "SALES_PRODUCT_SALE" }, "name": { "type": "string", "description": "Classification Name", "example": "Sales Product Sale" }, "description": { "type": "string", "description": "Classification description", "example": "Sales: Product Sale." }, "category": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentFinancialTransactionCategory" }, "subCategory": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentFinancialTransactionSubCategory" }, "type": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentFinancialTransactionType" } }, "description": "The transaction classification", "xml": { "name": "inventoryAdjustmentFinancialTransactionClass" } }, "PartnerInventoryService_InventoryAdjustmentFinancialTransactionSubCategory": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Sub Category Code", "example": "PRODUCT_SALES" }, "name": { "type": "string", "description": "Sub Category Name", "example": "Product Sales" }, "description": { "type": "string", "description": "Sub Category description", "example": "Product Sales Activity." } }, "description": "The transaction subcategory", "xml": { "name": "inventoryAdjustmentFinancialTransactionSubCategory" } }, "PartnerInventoryService_InventoryAdjustmentFinancialTransactionType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Type Code", "example": "PRODUCT_SALE" }, "name": { "type": "string", "description": "Type Name", "example": "Product Sale" }, "description": { "type": "string", "description": "Type description", "example": "Product Sale." } }, "description": "The transaction type", "xml": { "name": "inventoryAdjustmentFinancialTransactionType" } }, "PartnerInventoryService_InventoryAdjustmentOperator": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Operator Code", "example": "INCREMENT" }, "name": { "type": "string", "description": "Operator Name", "example": "Increment" }, "description": { "type": "string", "description": "Operator description", "example": "An adjustment resulting in the addition of inventory supply. " } }, "description": "Inventory Adjustment Operator", "xml": { "name": "inventoryAdjustmentOperator" } }, "PartnerInventoryService_InventoryAdjustmentReconStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Reconciliation Status Code", "example": "PENDING_RECONCILIATION" }, "name": { "type": "string", "description": "Reconciliation Status Name", "example": "Pending Reconciliation" }, "description": { "type": "string", "description": "Reconciliation Status description", "example": "The inventory adjustment is pending reconciliation with financial transactions." } }, "description": "Inventory Adjustment Reconciliation Status", "xml": { "name": "inventoryAdjustmentReconStatus" } }, "PartnerInventoryService_InventoryAdjustmentSystem": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "System Code", "example": "PARTNER_CENTRAL" }, "name": { "type": "string", "description": "System Name", "example": "Partner Central" }, "description": { "type": "string", "description": "System description", "example": "Partner Central" } }, "description": "Inventory Adjustment System", "xml": { "name": "inventoryAdjustmentSystem" } }, "PartnerInventoryService_InventoryAdjustmentType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Type Code", "example": "SUPPLY_DROP_SHIP_SOLD" }, "name": { "type": "string", "description": "Type Name", "example": "Drop Ship Sold Supply" }, "description": { "type": "string", "description": "Type description", "example": "An inventory adjustment performed to update the Drop Ship Sold Supply inventory quantity." } }, "description": "Inventory Adjustment Type", "xml": { "name": "inventoryAdjustmentType" } }, "PartnerInventoryService_PartnerInventoryAdjustmentDetail": { "required": [ "adjustmentClassification", "adjustmentOperator", "adjustmentReconStatus", "adjustmentSkuNumber", "adjustmentSystem", "inventoryAdjustmentTransactionsList", "inventoryAdjustmentType", "inventoryAdjustmentUuid" ], "type": "object", "properties": { "inventoryAdjustmentUuid": { "type": "string", "description": "Inventory Adjustment ID", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "inventoryAdjustmentId" } }, "adjustmentTransactionNumber": { "type": "string", "description": "The adjustment reference number for the transaction", "example": "TR9999999" }, "adjustmentSkuNumber": { "type": "string", "description": "The SKU number.", "example": "3361353" }, "styleImageUrl": { "type": "string", "description": "The style image url", "example": "http = //i5.jtv.com/loadimage.aspx?btype=.jpg&cgid=3361353" }, "adjustmentDateTime": { "type": "string", "description": "Adjustment Date Time", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "adjustmentQuantity": { "type": "integer", "description": "The inventory adjustment quantity", "format": "int32", "example": 2 }, "adjustmentUnitCost": { "type": "number", "description": "The inventory adjustment unit cost", "example": 50 }, "adjustmentTotalCost": { "type": "number", "description": "The inventory adjustment total cost", "example": 100 }, "adjustmentClassification": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentClass" }, "adjustmentOperator": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentOperator" }, "adjustmentSystem": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentSystem" }, "adjustmentReconStatus": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentReconStatus" }, "inventoryAdjustmentType": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentType" }, "inventoryAdjustmentTransactionsList": { "type": "array", "description": "inventory Adjustment Financial Transaction List", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerInventoryService_InventoryAdjustmentFinancialTransaction" } } }, "description": "Partner Inventory Adjustment Detail Representation", "xml": { "name": "partnerInventoryAdjustmentDetail" } }, "PartnerInventoryService_PartnerInventoryAdjustmentDetailResponse": { "required": [ "partnerInventoryAdjustmentDetail" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerInventoryAdjustmentDetail": { "$ref": "#/components/schemas/PartnerInventoryService_PartnerInventoryAdjustmentDetail" } }, "xml": { "name": "partnerInventoryAdjustmentDetailResponse" } }, "PartnerJewelPayCreditRiskService_CreateCreditRiskSelectionResponse": { "required": [ "creditRiskSelectionId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "creditRiskSelectionId": { "type": "string", "description": "The unique code representing an existing credit risk selection.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createCreditRiskSelectionResponse" } }, "PartnerJewelPayCreditRiskService_CreateCreditRiskSelectionRequest": { "required": [ "creditRiskOptionCode", "serviceEnrollmentId", "signature", "signedDateTime" ], "type": "object", "properties": { "serviceEnrollmentId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The service enrollment's unique universal identifier." }, "creditRiskOptionCode": { "type": "string", "description": "Enumeration of the Credit Risk Option Codes", "xml": { "name": "creditRiskOptionCode" }, "enum": [ "OPTION_1", "OPTION_2" ] }, "signature": { "type": "string", "description": "The user's signature for the credit risk selection." }, "signedDateTime": { "type": "string", "description": "The date and time for the credit risk selection signature.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "createCreditRiskSelectionRequest" } }, "PartnerJewelPayCreditRiskService_CreditRiskOption": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the credit risk option.", "example": "OPTION_1" }, "name": { "type": "string", "description": "The short name for the option.", "example": "Option 1" }, "description": { "type": "string", "description": "The description of the credit risk option.", "example": "Receive monthly installments as they are paid by your customers." } }, "description": "A credit risk option.", "xml": { "name": "creditRiskOption" } }, "PartnerJewelPayCreditRiskService_CreditRiskSelection": { "type": "object", "properties": { "creditRiskSelectionId": { "type": "string", "description": "The unique code representing the credit risk selection.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "serviceEnrollmentId": { "type": "string", "description": "The unique code representing the service enrollment.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "creditRiskOption": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_CreditRiskOption" }, "signature": { "type": "string", "description": "The credit risk signature." }, "signedDateTime": { "type": "string", "description": "The credit risk signature's signed date.", "format": "date-time" } }, "description": "A credit risk selection.", "xml": { "name": "creditRiskSelection" } }, "PartnerJewelPayCreditRiskService_GetPartnerJewelPayCreditRiskSelectionListResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "creditRiskSelections": { "type": "array", "description": "The list of available credit risk selections.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerJewelPayCreditRiskService_CreditRiskSelection" } } }, "xml": { "name": "getPartnerJewelPayCreditRiskSelectionListResponse" } }, "PartnerOrderService_GetPartnerCarriersServiceResponse": { "required": [ "partnerCarriers" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerCarriers": { "type": "array", "description": "The list of partner carriers.", "xml": { "name": "partnerCarrier", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_PartnerCarrier" } } }, "xml": { "name": "getPartnerCarriersServiceResponse" } }, "PartnerOrderService_PartnerCarrier": { "required": [ "carrierDisplayName", "code", "description", "displayOrder", "platformPartnerCarrierTypeCode", "platformPartnerCarrierTypeDisplayName" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the partner carrier.", "example": "JTV_OTHER_CARRIER_UPS" }, "carrierDisplayName": { "type": "string", "description": "The name representing the partner carrier.", "example": "UPS - United Parcel Service" }, "description": { "type": "string", "description": "The description representing the partner carrier.", "example": "UPS - United Parcel Service" }, "displayOrder": { "type": "integer", "description": "The displayOrder representing the partner carrier.", "format": "int32", "example": 2 }, "platformPartnerCarrierTypeCode": { "type": "string", "description": "The unique code representing the platform partner carrier.", "example": "JTV_OTHER_CARRIER" }, "platformPartnerCarrierTypeDisplayName": { "type": "string", "description": "The name representing the platform partner carrier.", "example": "Other Carrier" } }, "description": "The Partner Carrier", "xml": { "name": "partnerCarrier" } }, "PartnerOrderService_GetOrderLine": { "required": [ "quantity" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing an existing order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "supplierSkuNumber": { "type": "string", "description": "The Supplier SKU Number being ordered." }, "skuNumber": { "type": "string", "description": "The SKU Number being ordered." }, "lineNumber": { "type": "integer", "description": "The SKU order line number.", "format": "int32" }, "quantity": { "type": "integer", "description": "The quantity being ordered.", "format": "int32", "example": 100 }, "packageQuantity": { "type": "integer", "description": "The quantity of this order line currently assigned to packages.", "format": "int32", "example": 80 }, "orderLineCurrentValue": { "type": "number", "description": "The value of sellable product represented by the order line.", "format": "double", "example": 800.0 }, "size": { "type": "string", "description": "The size of the SKU, if applicable", "example": "7.5" }, "availableToSell": { "type": "integer", "description": "The quantity of this SKU currently available to sell", "format": "int32", "example": 50 }, "availableQuantity": { "type": "integer", "description": "The total quantity of this SKU that is currently available", "format": "int32", "example": 50 }, "soldQuantity": { "type": "integer", "description": "The quantity of this SKU currently sold", "format": "int32", "example": 50 }, "unsellableQuantity": { "type": "integer", "description": "The quantity of this SKU currently unsellable", "format": "int32", "example": 50 }, "inboundQuantity": { "type": "integer", "description": "The quantity of this SKU currently inbound", "format": "int32", "example": 50 }, "supplyTotalAvailableToPromise": { "type": "integer", "description": "The number of units available to promise for this SKU", "format": "int32" }, "supplyDistributionCenterOnHand": { "type": "integer", "description": "The number of DC units available for this SKU", "format": "int32" }, "orderLineStatus": { "$ref": "#/components/schemas/PartnerOrderService_OrderLineStatus" } }, "description": "An order line from a get call.", "xml": { "name": "getOrderLine" } }, "PartnerOrderService_GetOrderLinesFilters": { "type": "object", "properties": { "listingStatuses": { "type": "array", "description": "The avaliable listing status filters", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_ListingStatus" } }, "productTypes": { "type": "array", "description": "The available product type filters", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The available product type filters", "xml": { "name": "productType" } } }, "fulfillmentServiceOfferings": { "type": "array", "description": "The available fulfillment service offering filters", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_ServiceOffering" } } }, "description": "The get order lines avaliable filters.", "xml": { "name": "GetOrderLinesFilters" } }, "PartnerOrderService_GetOrderLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "getOrderLinesInfo": { "$ref": "#/components/schemas/PartnerOrderService_OrderLinesInfo" } }, "xml": { "name": "getOrderLinesResponse" } }, "PartnerOrderService_ListingStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the listing status.", "example": "PENDING" }, "name": { "type": "string", "description": "The name for the listing status.", "example": "Pending" }, "description": { "type": "string", "description": "The description of the listing status.", "example": "The listing is currently pending activation." } }, "description": "The listing status.", "xml": { "name": "ListingStatus" } }, "PartnerOrderService_OrderLineStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order line status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The short name for the order line status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description of the order line status.", "example": "The order line is currently being designed and is pending completion." } }, "description": "The order line status.", "xml": { "name": "orderLineStatus" } }, "PartnerOrderService_OrderLinesForStyle": { "required": [ "orderLines", "orderSkuCount", "productType", "styleNumber" ], "type": "object", "properties": { "styleNumber": { "type": "string", "description": "The style number", "example": "ABC1234" }, "productType": { "type": "string", "description": "The style product type", "example": "Ring" }, "titleDescription": { "type": "string", "description": "The title description of the style" }, "imageUrl": { "type": "string", "description": "The image URL of the style" }, "supplierStyleNumber": { "type": "string", "description": "The supplier's style number" }, "sellingPrice": { "type": "number", "description": "Selling price" }, "averageRating": { "type": "string", "description": "The average rating of the reviews given for this style" }, "numberOfReviews": { "type": "integer", "description": "The number reviews given for this style", "format": "int32" }, "orderSkuCount": { "type": "integer", "description": "The total count of SKUs for the style in the order", "format": "int32", "example": 5 }, "supplyTotalAvailableToPromise": { "type": "integer", "description": "The number of units available to promise across all SKUs for this style", "format": "int32" }, "supplyDistributionCenterOnHand": { "type": "integer", "description": "The number of DC units available across all SKUs for this style", "format": "int32" }, "orderLines": { "type": "array", "description": "The filtered order lines for this style in the order", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderLine" } }, "styleListingStatus": { "$ref": "#/components/schemas/PartnerOrderService_StyleListingStatus" }, "styleFulfillmentService": { "$ref": "#/components/schemas/PartnerOrderService_StyleFulfillmentService" } }, "description": "The order lines for a style.", "xml": { "name": "orderLinesForStyle" } }, "PartnerOrderService_OrderLinesInfo": { "required": [ "numFilteredSkus", "numFilteredStyles", "numTotalSkus", "numTotalStyles", "orderUuid" ], "type": "object", "properties": { "orderUuid": { "type": "string", "description": "The unique code representing an existing order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "numTotalStyles": { "type": "integer", "description": "The total number of styles in the order", "format": "int32", "example": 10 }, "numFilteredStyles": { "type": "integer", "description": "The total number of style in the order that pass the keyword filter", "format": "int32", "example": 8 }, "numTotalSkus": { "type": "integer", "description": "The total number of SKUs/lines in the order", "format": "int32", "example": 20 }, "numFilteredSkus": { "type": "integer", "description": "The total number of SKUs/lines in the order that pass the keyword filter", "format": "int32", "example": 15 }, "getOrderLinesForStyles": { "type": "array", "description": "List of order lines grouped by style", "xml": { "name": "orderLinesForStyles", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderLinesForStyle" } }, "getOrderLinesFilters": { "$ref": "#/components/schemas/PartnerOrderService_GetOrderLinesFilters" } }, "description": "The payload of the get order lines call.", "xml": { "name": "orderLinesInfo" } }, "PartnerOrderService_ServiceOffering": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the service offering.", "example": "ACTIVE" }, "name": { "type": "string", "description": "The short name for the service offering.", "example": "Active" }, "description": { "type": "string", "description": "The description of the service offering.", "example": "The service offering is currently active." } }, "description": "The get order lines service offerings.", "xml": { "name": "ServiceOffering" } }, "PartnerOrderService_StyleFulfillmentService": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the style fulfillment service.", "example": "BJMS_SELL" }, "name": { "type": "string", "description": "The short name for the style fulfillment service.", "example": "Sell on Jedora" }, "description": { "type": "string", "description": "The description of the style fulfillment service.", "example": "The Sell on Jedora service allows sellers to offer their listings for sale on the Jedora Marketplace platform" } }, "description": "The style fulfillment service.", "xml": { "name": "styleListingStatus" } }, "PartnerOrderService_StyleListingStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the style listing status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The short name for the style listing status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description of the style listing status.", "example": "The order line is currently being designed and is pending completion." } }, "description": "The style listing status.", "xml": { "name": "styleListingStatus" } }, "PartnerOrderService_CreateOrderHeaderResponse": { "required": [ "orderId", "orderStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderId": { "type": "string", "description": "The unique code representing an existing order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderStatus": { "$ref": "#/components/schemas/PartnerOrderService_OrderStatus" } }, "xml": { "name": "createOrderHeaderResponse" } }, "PartnerOrderService_OrderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The short name for the order status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description of the order status.", "example": "The order is currently being designed and is pending completion." } }, "description": "The order status.", "xml": { "name": "orderStatus" } }, "PartnerOrderService_CreateOrderHeaderRequest": { "required": [ "destinationSiteId", "orderName", "orderTypeCode", "originSiteId", "shippingCarrierCode" ], "type": "object", "properties": { "orderName": { "pattern": "^[\\p{Print}\\p{L}]{1,40}$", "type": "string", "description": "The string representing what the user wants to name the order" }, "orderTypeCode": { "type": "string", "description": "The code representing the order type the user wants to create", "enum": [ "PARTNER_REPLENISH_ORDER", "PARTNER_REMOVAL_ORDER", "PARTNER_REJECT_ORDER" ] }, "originSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's origin site" }, "destinationSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's destination site" }, "shippingCarrierCode": { "type": "string", "description": "The code representing the shipping carrier the user wants to use", "enum": [ "JTV_PARTNERED_CARRIER_UPS", "JTV_OTHER_CARRIER_UPS", "JTV_OTHER_CARRIER_USPS", "JTV_OTHER_CARRIER_FEDEX", "JTV_OTHER_CARRIER_DHL", "JTV_OTHER_CARRIER_DROP_OFF", "JTV_OTHER_CARRIER_OTHER", "BJMS_PARTNERED_CARRIER_UPS", "BJMS_CUSTOM_CARRIER_UPS", "BJMS_CUSTOM_CARRIER_USPS", "BJMS_CUSTOM_CARRIER_FEDEX", "BJMS_CUSTOM_CARRIER_DHL", "BJMS_CUSTOM_CARRIER_DROP_OFF", "BJMS_CUSTOM_CARRIER_OTHER" ] }, "carrierServiceCode": { "type": "string", "description": "The code representing the shipping carrier service the user wants to use" } }, "xml": { "name": "createOrderHeaderRequest" } }, "PartnerOrderService_CarrierService": { "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the carrier service.", "example": "JTV_OTHER_CARRIER_UPS" }, "name": { "type": "string", "description": "The name representing the carrier service.", "example": "UPS - United Parcel Service" }, "description": { "type": "string", "description": "The description representing the carrier service.", "example": "UPS - United Parcel Service" }, "serviceCode": { "type": "string", "description": "The description representing the carrier service code.", "example": "UPS - United Parcel Service" }, "expectedShipDate": { "type": "string", "description": "The description representing expected ship date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "estimatedDeliveryDate": { "type": "string", "description": "The description representing estimated delivery date for order packages.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The Partner Order Chosen Carrier Service", "xml": { "name": "carrierService" } }, "PartnerOrderService_GetOrderDetailsResponse": { "required": [ "carrierService", "createDate", "destinationSiteId", "orderHeaderId", "orderName", "orderNumber", "orderStatus", "orderSummaryMetrics", "orderType", "originSiteId", "partnerCarrier", "shipmentNumber" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderHeaderId": { "type": "string", "description": "The order header's ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderNumber": { "type": "string", "description": "The order's unique number.", "example": "PS2CG813721C" }, "shipmentNumber": { "type": "string", "description": "The order's shipment's unique number.", "example": "PS2CG813721C" }, "orderName": { "type": "string", "description": "The order's name.", "example": "PSCC2P4R6W2L 05/24/20 01:31 PM" }, "orderStatus": { "$ref": "#/components/schemas/PartnerOrderService_OrderStatus" }, "orderType": { "$ref": "#/components/schemas/PartnerOrderService_OrderType" }, "createDate": { "type": "string", "description": "The date the order was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "modifiedDate": { "type": "string", "description": "The date the order was last modified.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "originSiteId": { "type": "string", "description": "The order's origin site ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "destinationSiteId": { "type": "string", "description": "The order's origin site ID.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "partnerCarrier": { "$ref": "#/components/schemas/PartnerOrderService_PartnerCarrier" }, "orderSummaryMetrics": { "$ref": "#/components/schemas/PartnerOrderService_OrderSummaryMetrics" }, "orderReceiptSummary": { "$ref": "#/components/schemas/PartnerOrderService_OrderReceiptSummary" }, "orderQcSummary": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageQCSummary" }, "packageSummaries": { "type": "array", "description": "The list of packages for this order, and their receipt and quality control details.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageSummary" } }, "carrierService": { "$ref": "#/components/schemas/PartnerOrderService_CarrierService" }, "estimatedServiceFees": { "$ref": "#/components/schemas/PartnerOrderService_OrderEstimatedServiceFees" }, "carrierServiceCode": { "type": "string", "description": "The carrier service code, if this order is a removal order." }, "expectedDeliveryDate": { "type": "string", "description": "The expected delivery date for the order header detail", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "xml": { "name": "getOrderDetailsResponse" } }, "PartnerOrderService_OrderEstimatedServiceFees": { "type": "object", "properties": { "serviceFees": { "type": "array", "description": "The order service fees.", "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderRateServiceFee" } }, "totalServiceFees": { "type": "number", "description": "The total service fees for the order.", "format": "double" } }, "description": "The order service fees.", "xml": { "name": "orderEstimatedServiceFees" } }, "PartnerOrderService_OrderPackageQCFailureDetail": { "type": "object", "properties": { "failedQuantity": { "type": "integer", "description": "The batch quantity that failed QC.", "format": "int32" }, "failureCategory": { "type": "string", "description": "The QC category for this failed batch" }, "failureReason": { "type": "string", "description": "The reason this batch failed QC." }, "failureComment": { "type": "string", "description": "The QC comments for this failed batch." } }, "description": "A detail record of a quality control session of a received package", "xml": { "name": "orderPackageQCFailureDetail" } }, "PartnerOrderService_OrderPackageQCSummary": { "type": "object", "properties": { "unitsReceived": { "type": "integer", "description": "The number of units received into QC", "format": "int32" }, "unitsPassed": { "type": "integer", "description": "The number of units that passed QC", "format": "int32" }, "unitsFailed": { "type": "integer", "description": "The number of units that failed QC", "format": "int32" }, "failedSkuCount": { "type": "integer", "description": "The count of unique SKUs that failed QC", "format": "int32" }, "rejectOrderNumbers": { "type": "array", "description": "The list of reject POs containing the failed units", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The list of reject POs containing the failed units", "xml": { "name": "rejectOrderNumber" } } } }, "description": "A summary of quality control information", "xml": { "name": "orderPackageQCSummary" } }, "PartnerOrderService_OrderPackageReceiptSummary": { "type": "object", "properties": { "skuCount": { "type": "integer", "description": "The count of received SKUs", "format": "int32" }, "originalQuantity": { "type": "integer", "description": "The quantity expected", "format": "int32" }, "receivedQuantity": { "type": "integer", "description": "The actual quantity received", "format": "int32" }, "varianceQuantity": { "type": "integer", "description": "The difference between the quantity expected and quantity received", "format": "int32" } }, "description": "A summary of receipt info ", "xml": { "name": "orderPackageReceiptSummary" } }, "PartnerOrderService_OrderPackageSkuDetail": { "type": "object", "properties": { "skuNumber": { "type": "string", "description": "The SKU number" }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number" }, "titleDescription": { "type": "string", "description": "The title description of the style of this SKU" }, "imageUrl": { "type": "string", "description": "The image URL for the style of this SKU" }, "size": { "type": "string", "description": "The size of the SKU, if applicable" }, "qcSummary": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageSkuQCSummary" }, "receiptSummary": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageReceiptSummary" } }, "description": "Details for a SKU within an order", "xml": { "name": "orderPackageSkuDetail" } }, "PartnerOrderService_OrderPackageSkuQCSummary": { "type": "object", "properties": { "unitsReceived": { "type": "integer", "description": "The number of units received into quality control", "format": "int32" }, "unitsFailed": { "type": "integer", "description": "The number of units failed by QC", "format": "int32" }, "sessionComments": { "type": "string", "description": "The QC session comments" }, "failureDetails": { "type": "array", "description": "The QC failure details", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageQCFailureDetail" } } }, "description": "Quality Control details for a SKU", "xml": { "name": "orderPackageSkuQCSummary" } }, "PartnerOrderService_OrderPackageSummary": { "type": "object", "properties": { "packageUuid": { "type": "string", "description": "The unique code representing this package.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageName": { "type": "string", "description": "The name of the package" }, "skuDetails": { "type": "array", "description": "The details of the SKUs of this package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageSkuDetail" } }, "receiptSummary": { "$ref": "#/components/schemas/PartnerOrderService_OrderReceiptSummary" }, "packageQcSummary": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageQCSummary" } }, "description": "Summary information for a package of an order", "xml": { "name": "orderPackageSummary" } }, "PartnerOrderService_OrderRateServiceFee": { "required": [ "orderTotalQuantity", "orderTransactionFee", "ratePrice", "rateType", "rateValueDescription" ], "type": "object", "properties": { "rateType": { "$ref": "#/components/schemas/PartnerOrderService_OrderRateType" }, "ratePrice": { "type": "number", "description": "The order service rate type.", "format": "double", "example": 0.25 }, "rateValueDescription": { "type": "string", "description": "The description of the service fee value.", "example": "$0.25 per unit" }, "orderTotalQuantity": { "type": "integer", "description": "The quantity of SKU corresponding to this rate service", "format": "int32", "example": 100 }, "orderTransactionFee": { "type": "number", "description": "The order service fees corresponding to the rate service.", "format": "double", "example": 25.0 } }, "description": "The order service fee.", "xml": { "name": "orderRateServiceFee" } }, "PartnerOrderService_OrderRateType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order service rate type.", "example": "CONSIGNMENT_INVENTORY_REMOVAL_FEE" }, "name": { "type": "string", "description": "The short name for the order service rate type.", "example": "Consignment Inventory Removal Fee" }, "description": { "type": "string", "description": "The description of the order service rate type.", "example": "Rate for Consignment Inventory Removal Fee." } }, "description": "The order service rate type.", "xml": { "name": "orderRateType" } }, "PartnerOrderService_OrderReceiptSummary": { "type": "object", "properties": { "totalReceipts": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageReceiptSummary" }, "expectedReceipts": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageReceiptSummary" }, "missingReceipts": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageReceiptSummary" }, "extraReceipts": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageReceiptSummary" }, "unexpectedReceipts": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageReceiptSummary" } }, "description": "A summary of receipts for an order or package", "xml": { "name": "orderReceiptSummary" } }, "PartnerOrderService_OrderSummaryMetrics": { "required": [ "packageCount", "skuCount", "styleCount", "totalOrderLineQuantity" ], "type": "object", "properties": { "styleCount": { "type": "integer", "description": "The number of unique styles in the order.", "format": "int32", "example": 8 }, "skuCount": { "type": "integer", "description": "The number of unique skus in the order.", "format": "int32", "example": 16 }, "packageCount": { "type": "integer", "description": "The total number of packages in the order.", "format": "int32", "example": 3 }, "totalOrderLineQuantity": { "type": "integer", "description": "The total number of items in the order.", "format": "int32", "example": 160 } }, "description": "Metrics describing an order", "xml": { "name": "orderSummaryMetrics" } }, "PartnerOrderService_OrderType": { "required": [ "associateUseFlag", "code", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the order type.", "example": "PARTNER_REPLENISH_ORDER" }, "name": { "type": "string", "description": "The short name for the order type.", "example": "Partner Replenish Order" }, "description": { "type": "string", "description": "The description of the order type.", "example": "The Partner Replenish Order is the type of order used by Partners to request that inventory be replenished and shipped to a distribution center." }, "associateUseFlag": { "type": "boolean", "description": "The flag denoting if the order type is intended for associate use.", "example": true }, "displayOrder": { "type": "integer", "description": "The order in which to display order types", "format": "int32", "example": 2 } }, "description": "The order type.", "xml": { "name": "orderType" } }, "PartnerOrderService_UpdateOrderHeaderResponse": { "required": [ "orderStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderStatus": { "$ref": "#/components/schemas/PartnerOrderService_OrderStatus" } }, "xml": { "name": "updateOrderHeaderResponse" } }, "PartnerOrderService_UpdateOrderHeaderRequest": { "required": [ "orderName", "originSiteId", "shippingCarrierCode" ], "type": "object", "properties": { "orderName": { "pattern": "^[\\p{Print}\\p{L}]{1,40}$", "type": "string", "description": "The string representing what the user wants to name the order" }, "originSiteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier for the partner's origin site, UNLESS this is a REMOVAL/REJECT order, in which case, set this to the DESTINATION site identifier" }, "shippingCarrierCode": { "type": "string", "description": "The code representing the shipping carrier the user wants to use", "enum": [ "JTV_PARTNERED_CARRIER_UPS", "JTV_OTHER_CARRIER_UPS", "JTV_OTHER_CARRIER_USPS", "JTV_OTHER_CARRIER_FEDEX", "JTV_OTHER_CARRIER_DHL", "JTV_OTHER_CARRIER_DROP_OFF", "JTV_OTHER_CARRIER_OTHER", "BJMS_PARTNERED_CARRIER_UPS", "BJMS_CUSTOM_CARRIER_UPS", "BJMS_CUSTOM_CARRIER_USPS", "BJMS_CUSTOM_CARRIER_FEDEX", "BJMS_CUSTOM_CARRIER_DHL", "BJMS_CUSTOM_CARRIER_DROP_OFF", "BJMS_CUSTOM_CARRIER_OTHER" ] }, "carrierServiceCode": { "type": "string", "description": "The code representing the shipping carrier service the user wants to use" } }, "xml": { "name": "updateOrderHeaderRequest" } }, "PartnerOrderService_DeleteOrderHeaderResponse": { "required": [ "orderId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderId": { "type": "string", "description": "The unique code representing the deleted order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "deleteOrderHeaderResponse" } }, "PartnerOrderService_CreateOrderLinesResponse": { "required": [ "orderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderUuid": { "type": "string", "description": "The unique code representing an existing order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderLineUuids": { "type": "array", "description": "List of uuids of created order lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of created order lines", "xml": { "name": "orderLineUuid" } } } }, "xml": { "name": "createOrderLinesResponse" } }, "PartnerOrderService_CreateOrderLine": { "required": [ "quantity", "skuNumber" ], "type": "object", "properties": { "skuNumber": { "type": "string", "description": "The SKU Number being ordered." }, "quantity": { "type": "integer", "description": "The quantity being ordered.", "format": "int32", "example": 100 } }, "description": "An order line to create", "xml": { "name": "createOrderLine" } }, "PartnerOrderService_CreateOrderLinesRequest": { "required": [ "orderLines" ], "type": "object", "properties": { "orderLines": { "type": "array", "description": "The order lines to create", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_CreateOrderLine" } } }, "xml": { "name": "createOrderLinesRequest" } }, "PartnerOrderService_UpdateOrderLinesResponse": { "required": [ "orderUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderUuid": { "type": "string", "description": "The unique code representing an existing order.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderLineUuids": { "type": "array", "description": "List of uuids of updated order lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of updated order lines", "xml": { "name": "orderLineUuid" } } } }, "xml": { "name": "updateOrderLinesResponse" } }, "PartnerOrderService_OrderLinePackageQuantity": { "required": [ "packageUuid", "quantity" ], "type": "object", "properties": { "packageUuid": { "type": "string", "description": "The unique code representing an existing package header to assign quantity from the given order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "type": "integer", "description": "The quantity being added to the package. Can assign a value from 0 to 99,999.", "format": "int32", "example": 100 } }, "description": "An order line to update", "xml": { "name": "orderLinePackageQuantity" } }, "PartnerOrderService_UpdateOrderLine": { "required": [ "errorCode", "errorMessage" ], "type": "object", "properties": { "orderLineId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing order line to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "errorCode": { "type": "string", "description": "The resulting error code.", "example": "PARTNER_ORDER_DATA_EXCEPTION" }, "errorMessage": { "type": "string", "description": "The resulting error message.", "example": "The order line quantity could not be updated" } }, "description": "An order line to update", "xml": { "name": "updateOrderLine" } }, "PartnerOrderService_UpdateOrderLinesRequest": { "required": [ "orderLines" ], "type": "object", "properties": { "orderLines": { "type": "array", "description": "The order lines to create", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLine" } } }, "xml": { "name": "updateOrderLinesRequest" } }, "PartnerOrderService_DeleteOrderLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deleteOrderLinesResponse" } }, "PartnerOrderService_DeleteOrderLinesRequest": { "required": [ "orderLineUuids" ], "type": "object", "properties": { "orderLineUuids": { "type": "array", "description": "The UUIDs of the order lines to delete", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The UUIDs of the order lines to delete", "xml": { "name": "orderLineUuid" } } } }, "xml": { "name": "deleteOrderLinesRequest" } }, "PartnerOrderService_CarrierCharge": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "currencyCode": { "type": "string" }, "monetaryValue": { "type": "number" }, "subType": { "type": "string" } }, "description": "The carrier charge.", "xml": { "name": "CarrierCharge" } }, "PartnerOrderService_CarrierTaxCharge": { "type": "object", "properties": { "type": { "type": "string" }, "monetaryValue": { "type": "number" } }, "description": "The carrier tax charge.", "xml": { "name": "CarrierTaxCharge" } }, "PartnerOrderService_OrderBillingWeight": { "type": "object", "properties": { "weight": { "type": "number", "format": "float" }, "unitOfMeasure": { "$ref": "#/components/schemas/PartnerOrderService_OrderUnitOfMeasure" } }, "description": "The order billing weight.", "xml": { "name": "orderBillingWeight" } }, "PartnerOrderService_OrderPackageResults": { "type": "object", "properties": { "packageLabelId": { "type": "string" }, "trackingNumber": { "type": "string" }, "baseServiceCharge": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" }, "serviceOptionsCharges": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" }, "itemizedCharges": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" } }, "totalPackageCharge": { "type": "number" } }, "description": "The order's package results" }, "PartnerOrderService_OrderShipmentCharges": { "type": "object", "properties": { "transportationCharges": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" }, "itemizedCharges": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" } }, "serviceOptionsCharges": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" }, "taxCharges": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_CarrierTaxCharge" } }, "totalCharges": { "$ref": "#/components/schemas/PartnerOrderService_CarrierCharge" } }, "description": "The order's shipment charges", "xml": { "name": "orderShipmentCharges" } }, "PartnerOrderService_OrderUnitOfMeasure": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "description": "The order unit of measure.", "xml": { "name": "orderUnitOfMeasure" } }, "PartnerOrderService_UpdateOrderHeaderStatusResponse": { "required": [ "orderStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderStatus": { "$ref": "#/components/schemas/PartnerOrderService_OrderStatus" }, "shipmentCharges": { "$ref": "#/components/schemas/PartnerOrderService_OrderShipmentCharges" }, "billingWeight": { "$ref": "#/components/schemas/PartnerOrderService_OrderBillingWeight" }, "shipmentLabelId": { "type": "string" }, "packageResults": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderPackageResults" } } }, "xml": { "name": "updateOrderHeaderStatusResponse" } }, "PartnerOrderService_UpdateOrderHeaderStatusRequest": { "required": [ "expectedShipDate", "orderStatus", "serviceCode", "shipmentId" ], "type": "object", "properties": { "orderStatus": { "pattern": "^COMPLETE$", "type": "string", "description": "The string representing the order status" }, "expectedShipDate": { "type": "string", "description": "The expected ship date for this order. [ 2001-07-04T12:08:56.235-07:00 ]", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "serviceCode": { "pattern": "^[0-9]{2}$", "type": "string", "description": "The shipment carrier service code. [ 01, 02, 13, 71, etc. ]", "example": "02" }, "shipmentId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The shipment's unique identifier (UUID) [ 889e6036-34ce-494d-b7da-d06b213583d6 ]", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "updateOrderHeaderStatusRequest" } }, "PartnerOrderService_GetOrderHeadersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerId": { "type": "string", "description": "The unique code representing the partner.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "numberOfOrders": { "type": "integer", "description": "The number of orders that satisfy the filter criteria.", "format": "int32", "example": 5 }, "numberOfFilteredOrders": { "type": "integer", "description": "The number of filtered orders that satisfy the filter criteria.", "format": "int32", "example": 5 }, "orders": { "type": "array", "description": "The paged list of orders that satisfy the filter criteria.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderHeader" } } }, "xml": { "name": "getOrderHeadersResponse" } }, "PartnerOrderService_OrderHeader": { "required": [ "orderHeaderId", "orderNumber", "orderStatus", "orderType", "skuCount", "totalQuantity" ], "type": "object", "properties": { "orderHeaderId": { "type": "string", "description": "The unique code representing an existing package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderNumber": { "type": "string", "description": "The number of the order." }, "orderStatus": { "$ref": "#/components/schemas/PartnerShipmentService_OrderStatus" }, "orderType": { "$ref": "#/components/schemas/PartnerShipmentService_OrderType" }, "createdDate": { "type": "string", "description": "The date order was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "totalQuantity": { "type": "integer", "description": "The total item quantity of within the order.", "format": "int32" }, "skuCount": { "type": "integer", "description": "The number of SKUs within the order.", "format": "int32" } }, "description": "The order information for the shipment.", "xml": { "name": "orderHeader" } }, "PartnerOrderService_OrderPackage": { "type": "object", "properties": { "packageId": { "type": "string", "description": "The unique code representing a package.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageNumber": { "type": "string", "description": "The unique package number.", "example": "2001-07-04T12:08:56.235-07:00" }, "packageOrdinal": { "type": "integer", "description": "The package ordinal.", "format": "int32" }, "packageStatusDate": { "type": "string", "description": "The date and time the package status was changed.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "packageUnitsShipped": { "type": "integer", "description": "The number of units shipped in this package.", "format": "int32", "xml": { "name": "unitsShipped" } }, "packageUnitsReceived": { "type": "integer", "description": "The number of units received in this package.", "format": "int32", "xml": { "name": "unitsReceived" } }, "packageUnitsPassedQualityControl": { "type": "integer", "description": "The number of units that passed quality control.", "format": "int32", "xml": { "name": "unitsPassedQualityControl" } }, "packageStatus": { "$ref": "#/components/schemas/PartnerOrderService_PackageStatus" } }, "description": "A package contained in an order.", "xml": { "name": "orderPackage" } }, "PartnerOrderService_PackageStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the package status.", "example": "SHIPPED" }, "name": { "type": "string", "description": "The short name for the package status.", "example": "Package Shipped" }, "description": { "type": "string", "description": "The description of the package status.", "example": "The package has been picked up by the carrier but has not yet arrived a the destination." } }, "description": "The package status.", "example": "2001-07-04T12:08:56.235-07:00", "xml": { "name": "packageStatus" } }, "order-type": { "type": "array", "description": "A filter for the types of partner order. valid = PARTNER_REPLENISH_ORDER, PARTNER_REMOVAL_ORDER, PARTNER_REJECT_ORDER", "example": "PARTNER_REPLENISH_ORDER", "items": { "type": "string", "description": "A filter for the types of partner order. valid = PARTNER_REPLENISH_ORDER, PARTNER_REMOVAL_ORDER, PARTNER_REJECT_ORDER", "example": "PARTNER_REPLENISH_ORDER" } }, "start-date": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "description": "The inclusive starting date for the order header search. Format: 2001-07-04T12:08:56.235-07:00", "example": "2001-07-04T12:08:56.235-07:00" }, "end-date": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "description": "The inclusive ending date for the order header search. Format: 2001-07-04T12:08:56.235-07:00", "example": "2001-07-04T12:08:56.235-07:00" }, "expected-delivery-start-date": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "description": "The inclusive starting expected delivery date for the order header search. Format: 2001-07-04T12:08:56.235-07:00", "example": "2001-07-04T12:08:56.235-07:00" }, "expected-delivery-end-date": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "description": "The inclusive ending expected delivery date for the order header search. Format: 2001-07-04T12:08:56.235-07:00", "example": "2001-07-04T12:08:56.235-07:00" }, "order-status": { "type": "array", "description": "A collection of the desired order status codes", "example": "SHIPPED", "items": { "type": "string", "description": "A collection of the desired order status codes", "example": "SHIPPED" } }, "PartnerOrderService_UpdateOrderShipmentStatusResponse": { "required": [ "orderStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderStatus": { "$ref": "#/components/schemas/PartnerOrderService_OrderStatus" } }, "xml": { "name": "updateOrderShipmentStatusResponse" } }, "PartnerOrderService_UpdateOrderShipmentStatusRequest": { "required": [ "orderStatus", "serviceCode", "shipmentId", "shippedDate" ], "type": "object", "properties": { "shipmentId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The shipment's unique universal identifier." }, "orderStatus": { "pattern": "^SHIPPED$", "type": "string", "description": "The string representing the order status" }, "shippedDate": { "type": "string", "description": "The order's shipped date. [ 2020-07-04T12:08:56.235-07:00 ]", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "serviceCode": { "pattern": "^[0-9]{2}$", "type": "string", "description": "The order's 2-digit carrier service code", "example": "02" } }, "xml": { "name": "updateOrderShipmentStatusRequest" } }, "PartnerOrderService_UpdateOrderLineQuantityResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "results": { "type": "array", "description": "List of updated order line quantity results", "xml": { "name": "orderLineResults", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLine" } } }, "xml": { "name": "updateOrderLineQuantityResponse" } }, "PartnerOrderService_UpdateOrderLineQuantity": { "required": [ "orderLineId", "quantity" ], "type": "object", "properties": { "orderLineId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique uuid representing an existing order line to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "type": "integer", "description": "The quantity being ordered.", "format": "int32", "example": 100 }, "quantityCancelled": { "type": "integer", "description": "The quantity being cancelled.", "format": "int32", "example": 10 } }, "description": "An order line to update", "xml": { "name": "updateOrderLineQuantity" } }, "PartnerOrderService_UpdateOrderLineQuantityRequest": { "required": [ "orderLines" ], "type": "object", "properties": { "orderLines": { "type": "array", "description": "The order lines to update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_UpdateOrderLineQuantity" } } }, "xml": { "name": "updateOrderLineQuantityRequest" } }, "PartnerOrderService_GetOrderTypesResponse": { "required": [ "orderTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderTypes": { "type": "array", "description": "The list of order types.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderType" } } }, "xml": { "name": "getOrderTypesResponse" } }, "PartnerOrderService_GetOrderTypeOrderStatusResponse": { "required": [ "orderTypeOrderStatuses" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderTypeOrderStatuses": { "type": "array", "description": "The list of Order Type Order Statuses.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderTypeOrderStatus" } } }, "xml": { "name": "getOrderTypeOrderStatusResponse" } }, "PartnerOrderService_OrderTypeOrderStatus": { "required": [ "orderTypeCode", "orderTypeName" ], "type": "object", "properties": { "orderTypeCode": { "type": "string", "description": "The order type code.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderTypeName": { "type": "string", "description": "The order type name.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "orderStatuses": { "type": "array", "description": "List of order statuses by order type", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_OrderStatus" } } }, "description": "The get order status list by order type", "xml": { "name": "orderTypeOrderStatus" } }, "CommunicationPreference": { "required": [ "communicationChannelType" ], "type": "object", "properties": { "communicationChannelType": { "type": "string", "description": "Communication channel type of 'EMAIL' or 'SMS'", "example": "EMAIL", "enum": [ "EMAIL", "SMS" ] }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An email for communication preference.", "example": "susan.smith@gmail.com" }, "phone": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_Phone" } }, "description": "Subscriber communication preferences" }, "PartnerSubscriberSubscriptionService_GetOrderSubscriberSubscriptionResponse": { "required": [ "orderSubscriberSubscription" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderSubscriberSubscription": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_PartnerSubscriberSubscription" } }, "xml": { "name": "partnerOrderSubscriberSubscriptionResponse" } }, "PartnerSubscriberSubscriptionService_PartnerSubscriberSubscription": { "required": [ "communicationPreferences", "subscriberName", "subscriberSubscriptionId", "subscriptionOfferingCode" ], "type": "object", "properties": { "subscriberName": { "type": "string", "description": "Subscriber name or nickname", "example": "Susan" }, "communicationPreferences": { "type": "array", "description": "Subscriber communication preferences", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CommunicationPreference" } }, "subscriptionOfferingCode": { "type": "string", "description": "Subscription offering code", "example": "ORDER_TRACKING_NOTIFICATIONS" }, "subscriberSubscriptionId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "Partner Subscriber Subscription UUID", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "A partner subscriber subscription", "xml": { "name": "partnerSubscriberSubscription" } }, "PartnerSubscriberSubscriptionService_Phone": { "required": [ "countryCode", "subscriberNumber" ], "type": "object", "properties": { "countryCode": { "pattern": "^[1]{0,1}|^852|^39|^972", "type": "string", "description": "Country code", "example": "1" }, "subscriberNumber": { "type": "string", "description": "The phone number.", "example": "6155841898" } }, "description": "A phone number for communication preference.", "xml": { "name": "phone" } }, "PartnerOrderSubscriberSubscriptionService_CreateOrderSubscriberSubscriptionInteractionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "orderSubscriberSubscriptionId": { "type": "string", "description": "Order subscriber subscription id" } }, "xml": { "name": "createOrderSubscriberSubscriptionResponse" } }, "PartnerOrderSubscriberSubscriptionService_CreateOrderSubscriberSubscriptionRequest": { "required": [ "createOrderSubscriberSubscription" ], "type": "object", "properties": { "createOrderSubscriberSubscription": { "$ref": "#/components/schemas/PartnerOrderSubscriberSubscriptionService_CreateSubscriberSubscription" } }, "xml": { "name": "createOrderSubscriberSubscriptionRequest" } }, "PartnerOrderSubscriberSubscriptionService_CreateSubscriberSubscription": { "required": [ "communicationPreferences", "subscriptionOfferingCode" ], "type": "object", "properties": { "communicationPreferences": { "type": "array", "description": "Subscriber communication preferences", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CommunicationPreference" } }, "subscriptionOfferingCode": { "type": "string", "description": "Subscription offering code", "example": "ORDER_TRACKING_NOTIFICATIONS" } }, "description": "The order subscriber subscription", "xml": { "name": "createSubscriberSubscription" } }, "PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionsResponse": { "required": [ "partnerSubscriberSubscriptions" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerSubscriberSubscriptions": { "type": "array", "description": "A list of partner subscriber subscriptions", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_PartnerSubscriberSubscription" } } }, "xml": { "name": "partnerSubscriberSubscriptionsResponse" } }, "PartnerOrderSubscriberSubscriptionService_DeleteOrderSubscriberSubscriptionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerSubscriberSubscriptionResponse" } }, "PartnerPackingSlipErrorResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string", "description": "The error message.", "example": "Invalid Request" }, "errors": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/JtvValidationError" } }, "errorShipmentHeaders": { "type": "string", "description": "Partner Packing Slip Error Shipment Header Ids", "example": "1234567 ,1234568" } }, "xml": { "name": "partnerPackingSlipErrorResponse" } }, "PartnerPackingSlipService_partnerPackingSlipRequest": { "required": [ "shipmentHeaderIdList" ], "type": "object", "properties": { "shipmentHeaderIdList": { "maxItems": 50, "minItems": 1, "uniqueItems": true, "type": "array", "description": "One or more shipment header ids to generate a packing slip for.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A shipment header id", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "shipmentHeaderId" } } } }, "xml": { "name": "partnerPackingSlipRequest" } }, "PartnerPackingSlipService_CreatePartnerPackSlipResponse": { "required": [ "packSlipId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packSlipId": { "type": "string", "description": "The unique code representing the packing slip created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerPackSlipResponse" } }, "PartnerPackingSlipJobService_createPartnerPackSlipRequest": { "type": "object", "properties": { "shipmentHeaderIdList": { "maxItems": 999, "minItems": 1, "uniqueItems": true, "type": "array", "description": "Optional parameter indicating one or more shipment header ids to generate a packing slip for.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A shipment header id", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "shipmentHeaderId" } } }, "shipmentBatchHeaderId": { "type": "string", "description": "Optional parameter indicating one shipment batch header id to generate a packing slip for.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentGroupHeaderId": { "type": "string", "description": "Optional parameter indicating one shipment group header id to generate a packing slip for.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "deliveryServiceOrderHeaderId": { "type": "string", "description": "Optional parameter indicating one delivery service order header id to generate a packing slip for.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createPartnerPackSlipRequest" } }, "PartnerPackingSlipService_PartnerPackSlipStatus": { "type": "object", "properties": { "packSlipId": { "type": "string", "description": "packing slip identifier" }, "partnerAssociateId": { "type": "string", "description": "partner associate who made the packing slip creation request" }, "createdOnDateTime": { "type": "string", "description": "packing slip creation date/time", "format": "date-time" }, "status": { "type": "string", "description": "packing slip status code" }, "description": { "type": "string", "description": "packing slip status description" }, "error": { "type": "string", "description": "error message for FAILED status" } }, "description": "Packing slip status", "xml": { "name": "partnerPackSlipStatus" } }, "PartnerPackingSlipService_PartnerPackSlipStatusListResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packSlipStatusList": { "type": "array", "description": "Packing slip status", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerPackSlipStatus" } } }, "xml": { "name": "partnerPackSlipStatusListResponse" } }, "PartnerPackingSlipService_PartnerPackSlipStatusResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packSlipStatus": { "$ref": "#/components/schemas/PartnerPackingSlipService_PartnerPackSlipStatus" } }, "xml": { "name": "partnerPackSlipStatusResponse" } }, "PartnerPatriotActService_CreatePartnerPatriotActQuestionnaireAnswersResponse": { "required": [ "patriotActQuestionnaireAnswerId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "patriotActQuestionnaireAnswerId": { "type": "string", "description": "The Patriot Act Questionnaire Answers ID", "xml": { "name": "patriotActQuestionnaireAnswersId" } } }, "xml": { "name": "createPartnerPatriotActQuestionnaireAnswersResponse" } }, "PartnerPatriotActService_PatriotActQuestionnaireAnswersRequest": { "required": [ "answer1", "answer2", "questionnaireUuid", "serviceEnrollmentUuid", "signature", "signedOnDate" ], "type": "object", "properties": { "questionnaireUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The Patriot Act Questionnaire unique identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "serviceEnrollmentUuid": { "type": "string", "description": "The partner's service enrollment unique identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "signature": { "type": "string", "description": "The partner's full name.", "example": "John Q. Public" }, "signedOnDate": { "type": "string", "description": "The signed on date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "answer1": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #1" }, "answer2": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #2" }, "answer3": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #3" }, "answer4": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #4" } }, "xml": { "name": "patriotActQuestionnaireAnswersRequest" } }, "PartnerPatriotActService_PartnerPatriotActQuestionnaire": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Partner Patriot Act Questionnaire Unique Resource Identifier" }, "question1": { "type": "string", "description": "Partner Patriot Act Questionnaire question #1" }, "question2": { "type": "string", "description": "Partner Patriot Act Questionnaire Question #2" }, "question3": { "type": "string", "description": "Partner Patriot Act Questionnaire Question #3" }, "question4": { "type": "string", "description": "Partner Patriot Act Questionnaire Question #4" } }, "description": "The Patriot Act Questionnaire", "xml": { "name": "partnerPatriotActQuestionnaire" } }, "PartnerPatriotActService_PartnerPatriotActQuestionnaireResponse": { "required": [ "patriotActQuestionnaire" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "patriotActQuestionnaire": { "$ref": "#/components/schemas/PartnerPatriotActService_PartnerPatriotActQuestionnaire" } }, "xml": { "name": "partnerPatriotActQuestionnaireResponse" } }, "PartnerPatriotActService_GetPartnerPatriotActQuestionnaireAnswersResponse": { "required": [ "patriotActQuestionnaireAnswers" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "patriotActQuestionnaireAnswers": { "type": "array", "description": "The list of Patriot Act Questionnaire Answers", "xml": { "name": "patriotActQuestionnaireAnswersList", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPatriotActService_PartnerPatriotActQuestionnaireAnswers" } } }, "xml": { "name": "getPartnerPatriotActQuestionnaireAnswersResponse" } }, "PartnerPatriotActService_PartnerPatriotActQuestionnaireAnswers": { "type": "object", "properties": { "patriotActAnswerId": { "type": "string", "description": "Partner Patriot Act Questionnaire Answer Key" }, "signature": { "type": "string", "description": "Partner Patriot Act Questionnaire Answer Signature" }, "signedOnDate": { "type": "string", "description": "Date the Questionnaire Answers were signed", "format": "date-time" }, "answer1": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #1" }, "answer2": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #2" }, "answer3": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #3" }, "answer4": { "type": "boolean", "description": "Partner Patriot Act Questionnaire Answer #4" } }, "description": "The Patriot Act Questionnaire Answers", "xml": { "name": "partnerPatriotActQuestionnaireAnswers" } }, "PartnerPricingOfferService_GetPricingOfferResponse": { "required": [ "priceOfferTypes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "priceOfferTypes": { "type": "array", "description": "The list of price offer types", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceOfferType" } } }, "xml": { "name": "getPricingOfferResponse" } }, "PartnerPricingOfferService_PriceOffer": { "required": [ "code", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code of the price offer" }, "name": { "type": "string", "description": "The name of the price offer" }, "description": { "type": "string", "description": "The description of the price offer" }, "displayOrder": { "type": "integer", "description": "The display order of the price offer", "format": "int32" } }, "description": "List of Price offers available for this type", "xml": { "name": "priceOffer" } }, "PartnerPricingOfferService_PriceOfferType": { "required": [ "code", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code of the price offer type" }, "name": { "type": "string", "description": "The name of the price offer type" }, "description": { "type": "string", "description": "The description of the price offer type" }, "displayOrder": { "type": "integer", "description": "The display order of the price offer type", "format": "int32" }, "priceOffers": { "type": "array", "description": "List of Price offers available for this type", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceOffer" } } }, "description": "The list of price offer types", "xml": { "name": "priceOfferType" } }, "PartnerPricingOfferService_CreateBatchDiscountPriceSchedulesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "priceScheduleResponses": { "type": "array", "description": "The list of created price schedule response", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleResponseInformation" } } }, "xml": { "name": "createBatchDiscountPriceSchedulesResponse" } }, "PartnerPricingOfferService_PriceScheduleResponseInformation": { "type": "object", "properties": { "styleListingId": { "type": "string", "description": "The unique id representing the style listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "priceScheduleId": { "type": "string", "description": "The unique id representing the price offer schedule.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "errorStatus": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleStatus" } }, "description": "The list of updated price schedules", "xml": { "name": "priceScheduleResponseInformation" } }, "PartnerPricingOfferService_PriceScheduleStatus": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code of the price schedule status" }, "name": { "type": "string", "description": "The name of the price schedule status" }, "description": { "type": "string", "description": "The description of the price schedule status" } }, "description": "The price schedule error status", "xml": { "name": "priceScheduleStatus" } }, "PartnerPricingOfferService_CreatePriceScheduleInformation": { "type": "object", "properties": { "styleListingId": { "type": "string", "description": "The style listing uuid" }, "priceOfferLabelCode": { "type": "string", "description": "The price offer label code of the price schedule" }, "price": { "type": "number", "description": "The price" }, "percentageDiscount": { "type": "number", "description": "Percentage Discount from the Current Base Price", "format": "float" }, "scheduledDateTime": { "$ref": "#/components/schemas/PartnerPricingOfferService_ScheduledDateTime" } }, "xml": { "name": "createPriceScheduleInformation" } }, "PartnerPricingOfferService_ScheduledDateTime": { "type": "object", "properties": { "startDateTime": { "type": "string", "description": "The start date time of the schedule", "example": "2001-07-04T12:08:56.235-07:00" }, "endDateTime": { "type": "string", "description": "The end date time of the schedule", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The Scheduled start and end date time, required-NULL for 'BASE', optional for 'DISCOUNT'", "xml": { "name": "scheduledDateTime" } }, "PartnerProductLabelService_CreateBatchDiscountPriceSchedulesRequest": { "required": [ "priceSchedules" ], "type": "object", "properties": { "priceSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_CreatePriceScheduleInformation" } } }, "xml": { "name": "createBatchDiscountPriceSchedulesRequest" } }, "PartnerPricingOfferService_UpdateBatchPriceSchedulesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "priceScheduleResponses": { "type": "array", "description": "The list of updated price schedules", "xml": { "name": "priceSchedules", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleResponseInformation" } } }, "xml": { "name": "updateBatchPriceSchedulesResponse" } }, "PartnerPricingOfferService_UpdatePriceScheduleInformation": { "required": [ "priceOfferType" ], "type": "object", "properties": { "priceOfferType": { "type": "string", "description": "The price offer type of the price schedule, should be one of either 'BASE' or 'DISCOUNT'" }, "styleListingId": { "type": "string", "description": "The style listing uuid, required for both 'BASE' and 'DISCOUNT'" }, "priceScheduleId": { "type": "string", "description": "The price schedule uuid, required-NULL for 'BASE', required for 'DISCOUNT'" }, "priceOfferLabelCode": { "type": "string", "description": "The price offer label code, required-NULL for 'BASE', required for 'DISCOUNT'" }, "price": { "type": "number", "description": "The price, required for 'BASE', optional for 'DISCOUNT'" }, "percentageDiscount": { "type": "number", "description": "Percentage Discount from the Current Base Price, required-NULL for 'BASE', optional for 'DISCOUNT'", "format": "float" }, "scheduledDateTime": { "$ref": "#/components/schemas/PartnerPricingOfferService_ScheduledDateTime" } }, "xml": { "name": "updatePriceScheduleInformation" } }, "PartnerProductLabelService_UpdateBatchPriceSchedulesRequest": { "required": [ "priceSchedules" ], "type": "object", "properties": { "priceSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_UpdatePriceScheduleInformation" } } }, "xml": { "name": "updateBatchPriceSchedulesRequest" } }, "PartnerPricingOfferService_GetPricingOfferExecutionScheduleHistoryResponse": { "required": [ "totalCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalCount": { "type": "integer", "description": "The total count of pricing offer execution records", "format": "int32", "example": 5 }, "styleListingId": { "type": "string", "description": "The style listing uuid" }, "productNumber": { "type": "string", "description": "The product number" }, "styleNumber": { "type": "string", "description": "The style number" }, "priceExecutionInformations": { "type": "array", "description": "The list of price execution records", "xml": { "name": "priceExecutions", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_PricingOfferExecutionInformation" } } }, "xml": { "name": "getPricingOfferExecutionScheduleHistoryResponse" } }, "PartnerPricingOfferService_PriceOfferLabel": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code of the price offer label" }, "name": { "type": "string", "description": "The name of the price offer label" }, "description": { "type": "string", "description": "The description of the price offer label" } }, "description": "The price offer label of the price schedule", "xml": { "name": "priceOfferLabel" } }, "PartnerPricingOfferService_PriceOfferLabelType": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code of the price offer type" }, "name": { "type": "string", "description": "The name of the price offer type" }, "description": { "type": "string", "description": "The description of the price offer type" } }, "description": "The price offer type of the price schedule", "xml": { "name": "priceOfferLabelType" } }, "PartnerPricingOfferService_PricingOfferExecutionInformation": { "type": "object", "properties": { "priceExecutionId": { "type": "string", "description": "The price execution uuid" }, "priceScheduleId": { "type": "string", "description": "The price schedule uuid" }, "priceOfferLabelType": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceOfferLabelType" }, "priceOfferLabel": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceOfferLabel" }, "price": { "type": "number", "description": "The price" }, "percentageDiscount": { "type": "number", "description": "Percentage Discount from the Current Base Price", "format": "float" }, "currentOffer": { "type": "boolean", "description": "True/False - conveys whether the price exection record is the currently active offer.", "xml": { "name": "isCurrentOffer" } } }, "description": "The list of price execution records", "xml": { "name": "pricingOfferExecutionInformation" } }, "PartnerPricingOfferService_GetProductPricingOfferSchedulesResponse": { "required": [ "filteredCount", "totalCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalCount": { "type": "integer", "description": "The total count of pricing offer schedules", "format": "int32", "example": 5 }, "filteredCount": { "type": "integer", "description": "The total count of filtered pricing offer schedules", "format": "int32", "example": 5 }, "styleListingId": { "type": "string", "description": "The style listing uuid" }, "productNumber": { "type": "string", "description": "The product number" }, "styleNumber": { "type": "string", "description": "The style number" }, "priceScheduleInformations": { "type": "array", "description": "The list of price schedules", "xml": { "name": "priceSchedules", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleInformation" } } }, "xml": { "name": "getProductPricingOfferSchedulesResponse" } }, "PartnerPricingOfferService_PriceScheduleCreateInformation": { "required": [ "dateTime", "firstName", "userName" ], "type": "object", "properties": { "dateTime": { "type": "string", "description": "The creation date time", "format": "date-time" }, "userName": { "type": "string", "description": "The creation user name" }, "firstName": { "type": "string", "description": "The creation first name" }, "lastName": { "type": "string", "description": "The creation last name" } }, "description": "The Price Offer Schedule Update Information", "xml": { "name": "priceScheduleCreateInformation" } }, "PartnerPricingOfferService_PriceScheduleInformation": { "type": "object", "properties": { "priceScheduleId": { "type": "string", "description": "The price schedule uuid" }, "priceOfferLabelType": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceOfferLabelType" }, "priceOfferLabel": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceOfferLabel" }, "price": { "type": "number", "description": "The price" }, "percentageDiscount": { "type": "number", "description": "Percentage Discount from the Current Base Price", "format": "float" }, "currentOffer": { "type": "boolean", "description": "True/False - conveys whether the price schedule is the currently active offer.", "xml": { "name": "isCurrentOffer" } }, "createInformation": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleCreateInformation" }, "updateInformation": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleCreateInformation" } }, "description": "The Price Schedule Information Details", "xml": { "name": "priceScheduleInformation" } }, "PartnerPricingOfferService_GetProductPricingOfferScheduleDetailResponse": { "required": [ "priceScheduleInformation" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingId": { "type": "string", "description": "The style listing uuid" }, "productNumber": { "type": "string", "description": "The product number" }, "styleNumber": { "type": "string", "description": "The style number" }, "priceScheduleInformation": { "$ref": "#/components/schemas/PartnerPricingOfferService_PriceScheduleInformation" } }, "xml": { "name": "getProductPricingOfferScheduleDetailResponse" } }, "PartnerProductLabelErrorResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string", "description": "The error message.", "example": "Invalid Request" }, "errors": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/JtvValidationError" } }, "errorSkus": { "type": "string", "description": "Partner Product Label Error Skus", "example": "JST458V ,JST502" } }, "xml": { "name": "partnerProductLabelErrorResponse" } }, "PartnerProductLabelService_ProductLabel": { "required": [ "labelQuantity", "skuNumber" ], "type": "object", "properties": { "skuNumber": { "type": "string", "description": "SKU Number", "example": "ACW03345" }, "labelQuantity": { "type": "integer", "description": "SKU label quantity", "format": "int32", "example": 10 } }, "xml": { "name": "skuLabel" } }, "PartnerProductLabelService_partnerProductLabelRequest": { "required": [ "productLabelList", "productLabelTemplateCode", "startingLabelPosition" ], "type": "object", "properties": { "productLabelTemplateCode": { "type": "string", "description": "Product Label Template Code", "example": "AVERY_5267", "enum": [ "AVERY_5267" ] }, "startingLabelPosition": { "type": "integer", "description": "The product label starting position", "format": "int32", "example": 1 }, "productLabelList": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerProductLabelService_ProductLabel" } } }, "xml": { "name": "partnerProductLabelRequest" } }, "PartnerListingService_GetPartnerListingLabelScheduleDetailResponse": { "required": [ "styleListingId", "styleNumber" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "styleNumber": { "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "productNumber": { "type": "string", "description": "The product number" }, "labelScheduleInformation": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelScheduleInfoDetail" } }, "xml": { "name": "getPartnerListingLabelScheduleDetailResponse" } }, "PartnerListingService_LabelScheduleTime": { "type": "object", "properties": { "startDateTime": { "type": "string", "description": "The schedule's start date/time. [ 2020-07-04T12:08:56.235-07:00 ]", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "endDateTime": { "type": "string", "description": "The schedule's end date/time. [ 2020-07-04T12:08:56.235-07:00 ]", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The scheduled time", "xml": { "name": "labelScheduleTime" } }, "PartnerListingService_ListingLabelScheduleInfoDetail": { "required": [ "labelScheduleId" ], "type": "object", "properties": { "labelScheduleId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The listing label schedule's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "currentLabel": { "type": "boolean", "description": "Is label the current label" }, "listingLabel": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelType" }, "scheduledTime": { "$ref": "#/components/schemas/PartnerListingService_LabelScheduleTime" }, "createInformation": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelScheduleUserInfo" }, "updateInformation": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelScheduleUserInfo" } }, "xml": { "name": "listingLabelScheduleInfoDetail" } }, "PartnerListingService_ListingLabelScheduleUserInfo": { "type": "object", "properties": { "userName": { "type": "string", "description": "The username" }, "firstName": { "type": "string", "description": "The firstname" }, "lastName": { "type": "string", "description": "The lastname" }, "dateTime": { "type": "string", "description": "The datetime when schedule is created or updated", "format": "date-time" } }, "description": "The scheduled update user information", "xml": { "name": "ListingLabelScheduleUserInfo" } }, "PartnerListingService_ListingLabelType": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The listing label code" }, "name": { "type": "string", "description": "The listing label name" }, "description": { "type": "string", "description": "The listing label description" }, "systemGenerated": { "type": "boolean", "description": "Indicates whether the Label is a System Generated Label vs a User Generated Label" } }, "description": "The label code description", "xml": { "name": "listingLabelType" } }, "PartnerListingService_GetPartnerListingLabelScheduleListResponse": { "required": [ "styleListingId", "styleNumber" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "styleNumber": { "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "productNumber": { "type": "string", "description": "The product number" }, "filteredListCount": { "type": "integer", "description": "The number of label schedules that passed any active filters.", "format": "int32" }, "totalListCount": { "type": "integer", "description": "The total number of label schedules for this partner, without any filters.", "format": "int32" }, "labelSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelScheduleInfo" } } }, "xml": { "name": "getPartnerListingLabelScheduleListResponse" } }, "PartnerListingService_ListingLabelScheduleInfo": { "required": [ "labelScheduleId" ], "type": "object", "properties": { "labelScheduleId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The listing label schedule's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "currentLabel": { "type": "boolean", "description": "Is label the current label" }, "listingLabel": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelType" }, "scheduledTime": { "$ref": "#/components/schemas/PartnerListingService_LabelScheduleTime" } }, "xml": { "name": "listingLabelScheduleInfo" } }, "PartnerListingService_LabelSchedule": { "required": [ "labelScheduleId", "status", "styleListingId" ], "type": "object", "properties": { "styleListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "labelScheduleId": { "type": "string", "description": "The schedule's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "status": { "$ref": "#/components/schemas/PartnerListingService_LabelScheduleStatus" } }, "description": "The unique identifiers of the created schedules", "xml": { "name": "labelSchedule" } }, "PartnerListingService_LabelScheduleStatus": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "integer", "description": "The HTTP status code.", "format": "int32", "example": 200 }, "name": { "type": "string", "description": "The HTTP status code name or business exception error code", "example": "CREATED, NOT_FOUND, PARTNER_LISTING_LABEL_INVALID_TYPE_CODE" }, "description": { "type": "string", "description": "The description." } }, "description": "The listing label schedule status", "xml": { "name": "labelScheduleStatus" } }, "PartnerListingService_PartnerListingLabelSchedulesResponse": { "required": [ "labelSchedules" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "labelSchedules": { "type": "array", "description": "The unique identifiers of the created schedules", "items": { "$ref": "#/components/schemas/PartnerListingService_LabelSchedule" } } }, "xml": { "name": "partnerListingLabelSchedulesResponse" } }, "PartnerListingService_CreateLabelScheduleInfo": { "required": [ "listingLabel", "styleListingId" ], "type": "object", "properties": { "styleListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "scheduledTime": { "$ref": "#/components/schemas/PartnerListingService_LabelScheduleTime" }, "listingLabel": { "$ref": "#/components/schemas/PartnerListingService_LabelCode" } }, "description": "The listing label schedules", "xml": { "name": "createLabelScheduleInfo" } }, "PartnerListingService_CreateListingLabelSchedulesRequest": { "required": [ "labelSchedules" ], "type": "object", "properties": { "labelSchedules": { "type": "array", "description": "The listing label schedules", "items": { "$ref": "#/components/schemas/PartnerListingService_CreateLabelScheduleInfo" } } }, "xml": { "name": "createListingLabelSchedulesRequest" } }, "PartnerListingService_LabelCode": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The listing label code" } }, "description": "The listing label code", "xml": { "name": "labelCode" } }, "PartnerListingService_UpdateLabelScheduleInfo": { "required": [ "labelScheduleId", "listingLabel", "styleListingId" ], "type": "object", "properties": { "styleListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner style's unique universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "scheduledTime": { "$ref": "#/components/schemas/PartnerListingService_LabelScheduleTime" }, "listingLabel": { "$ref": "#/components/schemas/PartnerListingService_LabelCode" }, "labelScheduleId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The label schedule's universal identifier.", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, "description": "The listing label schedules", "xml": { "name": "updateLabelScheduleInfo" } }, "PartnerListingService_UpdateListingLabelSchedulesRequest": { "required": [ "labelSchedules" ], "type": "object", "properties": { "labelSchedules": { "type": "array", "description": "The listing label schedules", "items": { "$ref": "#/components/schemas/PartnerListingService_UpdateLabelScheduleInfo" } } }, "xml": { "name": "updateListingLabelSchedulesRequest" } }, "PartnerListingService_DeletePartnerListingLabelScheduleResponse": { "required": [ "styleListingUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingUuid": { "type": "string", "description": "The unique identifier of the listing label schedule, if the delete is successful" } }, "xml": { "name": "deletePartnerListingLabelScheduleResponse" } }, "PartnerListingService_GetPartnerProductListingsResponse": { "required": [ "partnerListing" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerListing": { "$ref": "#/components/schemas/PartnerListingService_PartnerListing" } }, "xml": { "name": "getPartnerProductListingsResponse" } }, "PartnerListingService_InstallBillingInfo": { "required": [ "installBillingScheduleId", "installBillingTerms" ], "type": "object", "properties": { "installBillingScheduleId": { "type": "string", "description": "Installment Billing Schedule UUID", "example": "66c4093a-a643-4831-a8fd-cfba91eb66e1" }, "installBillingTerms": { "$ref": "#/components/schemas/PartnerListingService_InstallBillingTerms" }, "installBillingFeeEstimate": { "type": "number", "description": "The installment billing fee estimate", "example": 3.52 }, "installBillingEligible": { "type": "boolean", "description": "Eligible for Installment Billing", "example": true } }, "description": "The installment billing info for this style", "xml": { "name": "installBillingInfo" } }, "PartnerListingService_InstallBillingTerms": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Installment billing term code", "example": "3_PAY" }, "name": { "type": "string", "description": "Installment billing term name", "example": "3_Pay" }, "description": { "type": "string", "description": "Installment billing term description", "example": "The product style may be paid in 3 interest-free installments." } }, "description": "Partner Style Listing's Installment Billing Terms", "xml": { "name": "installBillingTerms" } }, "PartnerListingService_ListingLabelScheduledTime": { "required": [ "startDateTime" ], "type": "object", "properties": { "startDateTime": { "type": "string", "description": "Listing Label Scheduled Start Date Time", "format": "date-time" }, "endDateTime": { "type": "string", "description": "Listing Label Scheduled End Date Time", "format": "date-time" } }, "description": "The Listing Label Scheduled Time", "xml": { "name": "listingLabelScheduledTime" } }, "PartnerListingService_ListingStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Listing status code" }, "name": { "type": "string", "description": "Listing status name" }, "description": { "type": "string", "description": "Listing status description" } }, "description": "Listing Status for the style", "xml": { "name": "listingStatus" } }, "PartnerListingService_PartnerListing": { "required": [ "filteredProductCount", "filteredStyleCount", "legalName", "operatingName", "productListings", "totalProductCount", "totalStyleCount", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Partner generated UUID", "xml": { "name": "partnerUuid" } }, "orderUuid": { "type": "string", "description": "The order UUID, if one was provided" }, "legalName": { "type": "string", "description": "Partner legal name", "xml": { "name": "partnerLegalName" } }, "operatingName": { "type": "string", "description": "Partner operating name", "xml": { "name": "partnerOperatingName" } }, "availableListingStatuses": { "type": "array", "description": "Available listing statuses", "xml": { "wrapped": true }, "items": { "type": "string", "description": "Available listing statuses", "xml": { "name": "availableListingStatuses" } } }, "availableListingStatusItems": { "type": "array", "description": "Available listing status items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_ListingStatus" } }, "availableProductTypes": { "type": "array", "description": "Available product types", "xml": { "wrapped": true }, "items": { "type": "string", "description": "Available product types", "xml": { "name": "availableProductTypes" } } }, "availablePricingStatuses": { "type": "array", "description": "Available pricing statuses", "xml": { "wrapped": true }, "items": { "type": "string", "description": "Available pricing statuses", "xml": { "name": "availablePricingStatuses" } } }, "availablePricingStatusItems": { "type": "array", "description": "Available pricing status items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_PricingProposalStat" } }, "filteredStyleCount": { "type": "integer", "description": "Filtered style count", "format": "int32" }, "totalStyleCount": { "type": "integer", "description": "Total style count", "format": "int32" }, "filteredProductCount": { "type": "integer", "description": "Filtered product count", "format": "int32" }, "totalProductCount": { "type": "integer", "description": "Total product count", "format": "int32" }, "productListings": { "type": "array", "description": "Product listings", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_ProductListing" } } }, "description": "The partner listing information", "xml": { "name": "partnerListing" } }, "PartnerListingService_PricingProposal": { "required": [ "creationDate", "proposalStatus" ], "type": "object", "properties": { "proposalUuid": { "type": "string", "description": "Pricing Proposal ID" }, "proposedPrice": { "type": "number", "description": "Proposed selling price" }, "proposalStatus": { "type": "string", "description": "Status of the pricing proposal", "enum": [ "PENDING_REVIEW", "ACCEPTED", "REJECTED", "EXPIRED", "CANCELLED", "NONE_SUBMITTED" ] }, "creationDate": { "type": "string", "description": "The date the pricing proposal was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "modifiedDate": { "type": "string", "description": "The date the pricing proposal was last modified.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "requestDate": { "type": "string", "description": "The request date of the pricing proposal.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "expirationDate": { "type": "string", "description": "The date the pricing proposal will expire if it's pending was last modified.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Current pricing proposal for the SKU", "xml": { "name": "pricingProposal" } }, "PartnerListingService_PricingProposalStat": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Pricing proposal status code" }, "name": { "type": "string", "description": "Pricing proposal status name" }, "description": { "type": "string", "description": "Pricing proposal status description" } }, "description": "Available pricing status items", "xml": { "name": "pricingProposalStat" } }, "PartnerListingService_ProductListing": { "required": [ "minProductProposalRequestDate", "productAvailableQuantity", "productCreationDate", "productId", "productListingUuid", "productMasterId", "styleCount" ], "type": "object", "properties": { "productMasterId": { "type": "string", "description": "Product master ID" }, "productId": { "type": "string", "description": "Product ID" }, "productListingUuid": { "type": "string", "description": "The unique UUID of the product listing", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shopProfileListingId": { "type": "string", "description": "If the listings are for a Shop Profile, the UUID of the listing within that Profile", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "minProductSupplierPrice": { "type": "number", "description": "Minimum product supplier price" }, "maxProductSupplierPrice": { "type": "number", "description": "Maximum product supplier price" }, "minProductSellingPrice": { "type": "number", "description": "Minimum product selling price" }, "maxProductSellingPrice": { "type": "number", "description": "Maximum Product selling price" }, "minProductProposalRequestDate": { "type": "string", "description": "Earliest pricing proposal request date for the product, if there are any in-progress proposals", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "productAvailableQuantity": { "type": "integer", "description": "Total product inventory quantity for all styles/skus", "format": "int32" }, "productCreationDate": { "type": "string", "description": "The date the product listing was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "styleCount": { "type": "integer", "description": "The total number of styles for this product", "format": "int32", "example": 45 }, "styleListings": { "type": "array", "description": "Style Listings", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_StyleListing" } } }, "description": "Product listings", "xml": { "name": "productListing" } }, "PartnerListingService_Rating": { "required": [ "averageRating", "count" ], "type": "object", "properties": { "averageRating": { "type": "number", "description": "The average customer rating of the listing", "example": 4.2 }, "count": { "type": "integer", "description": "The total number of ratings", "format": "int32", "example": 123 } }, "description": "Rating information for style", "xml": { "name": "rating" } }, "PartnerListingService_ServiceOffering": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Service offering code" }, "name": { "type": "string", "description": "Service offering name" }, "description": { "type": "string", "description": "Service offering description" } }, "description": "The fulfillment service through which this style is being fulfilled", "xml": { "name": "serviceOffering" } }, "PartnerListingService_SkuListing": { "required": [ "skuAvailableQuantity", "skuCreationDate", "skuNumber", "soldQuantity", "unsellableQuantity" ], "type": "object", "properties": { "skuNumber": { "type": "string", "description": "SKU Number" }, "supplierSkuNumber": { "type": "string", "description": "SKU Number" }, "size": { "type": "string", "description": "SKU size" }, "skuAvailableQuantity": { "type": "integer", "description": "SKU quantity available", "format": "int32" }, "unsellableQuantity": { "type": "integer", "description": "SKU quantity unsellable", "format": "int32" }, "soldQuantity": { "type": "integer", "description": "SKU quantity sold", "format": "int32" }, "inboundQuantity": { "type": "integer", "description": "SKU quantity inbound", "format": "int32" }, "availableToSellQuantity": { "type": "integer", "description": "SKU quantity available to sell", "format": "int32" }, "supplierPrice": { "type": "number", "description": "SKU supplier price" }, "currentPriceProposal": { "$ref": "#/components/schemas/PartnerListingService_PricingProposal" }, "skuCreationDate": { "type": "string", "description": "The date the sku listing was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "orderQuantity": { "type": "integer", "description": "Quantity of SKU assigned to the order, if given", "format": "int32" }, "packageQuantity": { "type": "integer", "description": "Quantity of SKU assigned to packages of the order, if an order is given", "format": "int32" }, "supplyDistributionCenterOnHand": { "type": "integer", "description": "SKU supply distribution center On-hold quantity", "format": "int32" }, "supplyDistributionCenterInbound": { "type": "integer", "description": "SKU supply distribution center Inbound quantity", "format": "int32" }, "supplyDistributionCenterAvailable": { "type": "integer", "description": "SKU supply distribution center available quantity", "format": "int32" }, "supplyDistributionCenterUnavailable": { "type": "integer", "description": "SKU supply distribution center unavailable quantity", "format": "int32" }, "supplyDistributionCenterSold": { "type": "integer", "description": "SKU supply distribution center sold quantity", "format": "int32" }, "supplyDropShipOnHand": { "type": "integer", "description": "SKU supply drop ship on-hand quantity", "format": "int32" }, "supplyDropShipAvailable": { "type": "integer", "description": "SKU supply drop ship available quantity", "format": "int32" }, "supplyDropShipUnavailable": { "type": "integer", "description": "SKU supply drop ship unavailable quantity", "format": "int32" }, "supplyDropShipSold": { "type": "integer", "description": "SKU supply drop ship sold quantity", "format": "int32" }, "supplyTotalAvailableToPromise": { "type": "integer", "description": "SKU supply total available to promise quantity", "format": "int32" } }, "description": "SKU Listings", "xml": { "name": "skuListing" } }, "PartnerListingService_StyleBasePriceInfo": { "required": [ "basePriceLabel", "basePriceScheduleId", "scheduledTime" ], "type": "object", "properties": { "basePriceScheduleId": { "type": "string", "description": "Base Price Schedule UUID for the style listing", "example": "66c4093a-a643-4831-a8fd-cfba91eb66e1" }, "basePriceLabel": { "$ref": "#/components/schemas/PartnerListingService_StyleListingPriceLabel" }, "basePrice": { "type": "number", "description": "Base Price Amount", "example": 1.92 }, "scheduledTime": { "$ref": "#/components/schemas/PartnerListingService_StylePriceScheduledTime" } }, "description": "The base price info for the style listing", "xml": { "name": "styleBasePriceInfo" } }, "PartnerListingService_StyleListing": { "required": [ "listingStatus", "skuCount", "styleAvailableQuantity", "styleCreationDate", "styleId", "styleImageUrl", "styleListingUuid", "styleProposalStatus", "styleTitleDescription" ], "type": "object", "properties": { "styleId": { "type": "string", "description": "Style ID" }, "styleListingUuid": { "type": "string", "description": "The unique UUID of the style listing", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "supplierStyleNumber": { "type": "string", "description": "Style supplier number" }, "minStyleSupplierPrice": { "type": "number", "description": "Min style supplier price" }, "maxStyleSupplierPrice": { "type": "number", "description": "Max style supplier price" }, "sellingPrice": { "type": "number", "description": "Selling price" }, "styleAvailableQuantity": { "type": "integer", "description": "Style total available quantity", "format": "int32" }, "styleCreationDate": { "type": "string", "description": "The date the style listing was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "styleImageUrl": { "type": "string", "description": "Primary image for style", "example": "https://images.jtv.com/jewelry/125/125/JTV-DOC458-1.jpg" }, "styleTitleDescription": { "type": "string", "description": "Title Description for listing", "example": "Multi Tourmaline 12.35ctw Oval, Rhodium Over Sterling Silver Bracelet" }, "productType": { "type": "string", "description": "Product Type", "example": "Ring" }, "rating": { "$ref": "#/components/schemas/PartnerListingService_Rating" }, "listingStatus": { "$ref": "#/components/schemas/PartnerListingService_ListingStatus" }, "styleProposalStatus": { "type": "string", "description": "Pricing Proposal Status for the style" }, "styleProposalMinPrice": { "type": "number", "description": "Minimum proposal price for the style, if there are any in-progress proposals" }, "styleProposalMinExpDate": { "type": "string", "description": "Earliest pricing proposal expiration date for the style, if there are any in-progress proposals", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "styleProposalMinRequestDate": { "type": "string", "description": "Earliest pricing proposal request date for the style, if there are any in-progress proposals", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "serviceOffering": { "$ref": "#/components/schemas/PartnerListingService_ServiceOffering" }, "fulfillmentServiceOffering": { "$ref": "#/components/schemas/PartnerListingService_ServiceOffering" }, "skuCount": { "type": "integer", "description": "Number of skus in the style", "format": "int32" }, "skuOrderCount": { "type": "integer", "description": "Number of skus of this style that are in the order, if one is provided", "format": "int32" }, "skuListings": { "type": "array", "description": "SKU Listings", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_SkuListing" } }, "installBillingInfo": { "$ref": "#/components/schemas/PartnerListingService_InstallBillingInfo" }, "stylePriceInfo": { "$ref": "#/components/schemas/PartnerListingService_StylePriceInfo" }, "futureDiscountPriceScheduleCount": { "type": "integer", "description": "Number of future discounted pricing schedules", "format": "int32" }, "currentStyleListingLabelSchedules": { "type": "array", "description": "Current Style Listing Label Schedules", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_StyleListingLabelScheduleInfo" } }, "styleSupplyDistributionCenterOnHand ": { "type": "integer", "description": "Style supply distribution center on-hand quantity", "format": "int32", "xml": { "name": "styleSupplyDistributionCenterOnHand" } }, "styleSupplyDistributionCenterAvailable": { "type": "integer", "description": "Style supply distribution center available quantity", "format": "int32" }, "styleSupplyDistributionCenterUnavailable": { "type": "integer", "description": "Style supply distribution center unavailable quantity", "format": "int32" }, "styleSupplyDistributionCenterInbound": { "type": "integer", "description": "Style supply distribution center inbound quantity", "format": "int32" }, "styleSupplyDistributionCenterSold": { "type": "integer", "description": "Style supply distribution center sold quantity", "format": "int32" }, "styleSupplyDropShipOnHand": { "type": "integer", "description": "Style supply drop ship on-hand quantity", "format": "int32" }, "styleSupplyDropShipAvailable": { "type": "integer", "description": "Style supply drop ship available quantity", "format": "int32" }, "styleSupplyDropShipUnavailable": { "type": "integer", "description": "Style supply drop ship unavailable quantity", "format": "int32" }, "styleSupplyDropShipSold": { "type": "integer", "description": "Style supply drop ship sold quantity", "format": "int32" }, "styleSupplyTotalAvailableToPromise": { "type": "integer", "description": "Style supply total available to promise quantity", "format": "int32" } }, "description": "Style Listings", "xml": { "name": "styleListing" } }, "PartnerListingService_StyleListingLabelScheduleInfo": { "required": [ "highestPriority", "labelScheduleId", "listingLabelScheduledTime", "listingLabelType", "styleListingId" ], "type": "object", "properties": { "styleListingId": { "type": "string", "description": "The style listing ID" }, "labelScheduleId": { "type": "string", "description": "The Label Schedule ID" }, "listingLabelType": { "$ref": "#/components/schemas/PartnerListingService_StyleListingLabelType" }, "listingLabelScheduledTime": { "$ref": "#/components/schemas/PartnerListingService_ListingLabelScheduledTime" }, "highestPriority": { "type": "boolean", "description": "The highest priority flag" } }, "description": "Current Style Listing Label Schedules", "xml": { "name": "styleListingLabelScheduleInfo" } }, "PartnerListingService_StyleListingLabelType": { "required": [ "code", "description", "name", "priority", "systemGenerated" ], "type": "object", "properties": { "code": { "type": "string", "description": "Listing Label Type Code" }, "name": { "type": "string", "description": "Listing Label Type Name" }, "description": { "type": "string", "description": "Listing Label Type Description" }, "systemGenerated": { "type": "boolean", "description": "Listing Label Type system generated" }, "priority": { "type": "integer", "description": "Listing Label Type priority", "format": "int32" } }, "description": "The Listing Label Type", "xml": { "name": "styleListingLabelType" } }, "PartnerListingService_StyleListingPriceLabel": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code for the style listing price label", "example": "SALE_PRICE" }, "name": { "type": "string", "description": "Name for the style listing price label", "example": "Sale Price" }, "description": { "type": "string", "description": "Description for the style listing price label", "example": "Sale Price" } }, "description": "Discount Price Label for the style listing", "xml": { "name": "styleListingPriceLabel" } }, "PartnerListingService_StylePriceInfo": { "required": [ "basePriceInfo" ], "type": "object", "properties": { "basePriceInfo": { "$ref": "#/components/schemas/PartnerListingService_StyleBasePriceInfo" }, "discountPriceInfo": { "$ref": "#/components/schemas/PartnerListingService_styleDiscountPriceInfo" } }, "description": "The listing price info for this style", "xml": { "name": "stylePriceInfo" } }, "PartnerListingService_StylePriceScheduledTime": { "required": [ "endDateTime", "startDateTime" ], "type": "object", "properties": { "startDateTime": { "type": "string", "description": "Start Date of the Style Listing Price Schedule", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "endDateTime": { "type": "string", "description": "End Date of the Style Listing Price Schedule", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Discount Price Scheduled time for the style listing", "xml": { "name": "stylePriceScheduledTime" } }, "PartnerListingService_styleDiscountPriceInfo": { "required": [ "discountPriceLabel", "discountPriceScheduleId", "scheduledTime" ], "type": "object", "properties": { "discountPriceScheduleId": { "type": "string", "description": "Discount Price Schedule UUID for the style listing", "example": "66c4093a-a643-4831-a8fd-cfba91eb66e1" }, "discountPriceLabel": { "$ref": "#/components/schemas/PartnerListingService_StyleListingPriceLabel" }, "discountPrice": { "type": "number", "description": "Discount Price Amount", "example": 1.92 }, "percentageOff": { "type": "number", "description": "Percentage Discount to Base Price", "format": "float", "example": 0.03 }, "scheduledTime": { "$ref": "#/components/schemas/PartnerListingService_StylePriceScheduledTime" } }, "description": "The discount price info for the style listing", "xml": { "name": "styleDiscountPriceInfo" } }, "PartnerListingService_CreatePartnerStyleMediaUploadUriResponse": { "required": [ "apiKey", "folder", "publicId", "signature", "timeStamp", "uploadPreset" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "signature": { "type": "string", "description": "The signature corresponding to the passed in media upload URI parameters." }, "timeStamp": { "type": "integer", "description": "The time stamp corresponding to when the media upload URI parameters were signed.", "format": "int64" }, "folder": { "type": "string", "description": "The folder name where the media should be uploaded." }, "apiKey": { "type": "string", "description": "The api key used for signature signing." }, "uploadPreset": { "type": "string", "description": "The upload preset used for signature signing." }, "publicId": { "type": "string", "description": "The asset's public identifier." } }, "xml": { "name": "createPartnerStyleMediaUploadUriResponse" } }, "PartnerListingService_CreatePartnerShopProfileMediaUploadUriRequest": { "required": [ "mediaUploadUriCoordinates", "source" ], "type": "object", "properties": { "mediaUploadUriCoordinates": { "$ref": "#/components/schemas/PartnerListingService_MediaUploadUriCoordinates" }, "source": { "type": "string", "description": "Describes the media upload source", "example": "uw" }, "filenameOverride": { "type": "string", "description": "Describes the filename override used by some Cloudinary widget integrations", "example": "IMG103034.png" }, "headers": { "type": "string", "description": "Describes headers used by some Cloudinary widget integrations", "example": "Dropbox-API-Arg: {\"path\":\"/img_2195.jpg\"} " } }, "xml": { "name": "createPartnerShopProfileMediaUploadUriRequest" } }, "PartnerListingService_MediaUploadUriCoordinates": { "required": [ "coordinates", "mediaUploadUriCoordinateType" ], "type": "object", "properties": { "coordinates": { "pattern": "^[0-9,|]{0,100}$", "type": "string", "description": "The comma separated numerical string representing the requested coordinates", "example": "146,243,932,825" }, "mediaUploadUriCoordinateType": { "type": "string", "description": "The enumerated type representing mutually exclusive coordinate parameters", "enum": [ "CUSTOM_COORDINATES", "FACE_COORDINATES" ] } }, "description": "Describes the optional coordinates and coordinate type.", "xml": { "name": "mediaUploadUriCoordinates" } }, "PartnerListingService_GetPartnerStyleMediaResponse": { "required": [ "maxMediaItems", "styleListingUuid", "styleNumber", "totalResultCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingUuid": { "type": "string", "description": "The unique code representing the style listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "styleNumber": { "type": "string", "description": "The style number of the style listing." }, "totalResultCount": { "type": "integer", "description": "The number of media items.", "format": "int32", "example": 4 }, "maxMediaItems": { "type": "integer", "description": "The maximum number of media items allowed.", "format": "int32", "example": 12 }, "mediaItems": { "type": "array", "description": "The media items for this style.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_MediaItem" } } }, "xml": { "name": "getPartnerStyleMediaResponse" } }, "PartnerListingService_MediaAngle": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "FRONT" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Front" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Front" } }, "description": "The angles of the media item.", "xml": { "name": "mediaAngle" } }, "PartnerListingService_MediaBackground": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "SOLID" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Solid" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Solid color background." } }, "description": "The backgrounds of the media item.", "xml": { "name": "mediaBackground" } }, "PartnerListingService_MediaContentType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "BRAND" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Brand" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Brand" } }, "description": "The content types of the media item.", "xml": { "name": "mediaContentType" } }, "PartnerListingService_MediaCropMode": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media crop mode.", "example": "NO_COORDINATES" }, "name": { "type": "string", "description": "The name representing the media crop mode.", "example": "No Coordinates" }, "description": { "type": "string", "description": "The description for the media crop mode.", "example": "No cropping mode has been applied." } }, "description": "The crop mode of the media item.", "xml": { "name": "mediaCropMode" } }, "PartnerListingService_MediaFormat": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media crop mode.", "example": "JPEG" }, "name": { "type": "string", "description": "The name representing the media crop mode.", "example": "JPEG" }, "description": { "type": "string", "description": "The description for the media crop mode.", "example": "JPEG or JPG" } }, "description": "The file format of the media item.", "xml": { "name": "mediaFormat" } }, "PartnerListingService_MediaItem": { "required": [ "createDate", "deliveryUrl", "lastModifiedByFirstName", "lastModifiedByLastName", "lastModifiedByUser", "moderationStatus", "positionOrdinal", "status", "transformation", "type", "uuid", "verificationStatus" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing the media item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "type": { "$ref": "#/components/schemas/PartnerListingService_MediaType" }, "publicId": { "type": "string", "description": "The public ID of the media item, if stored in Cloudinary." }, "version": { "type": "string", "description": "The version number of the media item, if stored in Cloudinary." }, "deliveryUrl": { "type": "string", "description": "The default delivery URL of the media item." }, "transformation": { "type": "string", "description": "The default transformation used in the delivery URL of the media item." }, "cropMode": { "$ref": "#/components/schemas/PartnerListingService_MediaCropMode" }, "cropCoordinates": { "type": "string", "description": "The crop coordinates of the media item.", "example": "100,200,0,500" }, "originalName": { "type": "string", "description": "The original name of the media item." }, "format": { "$ref": "#/components/schemas/PartnerListingService_MediaFormat" }, "subjects": { "type": "array", "description": "The subjects of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_MediaSubject" } }, "angles": { "type": "array", "description": "The angles of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_MediaAngle" } }, "backgrounds": { "type": "array", "description": "The backgrounds of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_MediaBackground" } }, "contentTypes": { "type": "array", "description": "The content types of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_MediaContentType" } }, "status": { "$ref": "#/components/schemas/PartnerListingService_MediaStatus" }, "verificationStatus": { "$ref": "#/components/schemas/PartnerListingService_MediaVerifyStatus" }, "moderationStatus": { "$ref": "#/components/schemas/PartnerListingService_MediaModerateStatus" }, "positionOrdinal": { "type": "integer", "description": "The position of this media item within the style.", "format": "int32", "example": 2 }, "createDate": { "type": "string", "description": "The date the media item was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "lastModifiedDate": { "type": "string", "description": "The date the media item was last modified since it was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "lastModifiedByUser": { "type": "string", "description": "The user name of the user who last modified the media." }, "lastModifiedByFirstName": { "type": "string", "description": "The first name of the user who last modified the media." }, "lastModifiedByLastName": { "type": "string", "description": "The last name of the user who last modified the media." } }, "description": "The media items for this style.", "xml": { "name": "mediaItem" } }, "PartnerListingService_MediaModerateStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "APPROVED" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Approved" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Media has been approved as a result of moderation review." } }, "description": "The moderation status of the media item.", "xml": { "name": "mediaModerateStatus" } }, "PartnerListingService_MediaStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "APPROVED" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Approved" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Approved Status" } }, "description": "The status of the media item.", "xml": { "name": "mediaStatus" } }, "PartnerListingService_MediaSubject": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "MODEL" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Model" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Model" } }, "description": "The subjects of the media item.", "xml": { "name": "mediaSubject" } }, "PartnerListingService_MediaType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media type.", "example": "PDF" }, "name": { "type": "string", "description": "The name representing the media type.", "example": "PDF" }, "description": { "type": "string", "description": "The description for the media type.", "example": "PDF File" } }, "description": "The type of the media item.", "xml": { "name": "mediaType" } }, "PartnerListingService_MediaVerifyStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "PENDING_VERIFICATION" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Pending Verification" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Media is awaiting verification of conformance with media requirements." } }, "description": "The verification status of the media item.", "xml": { "name": "mediaVerifyStatus" } }, "PartnerListingService_CreatePartnerStyleMediaResponse": { "required": [ "uuids" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "uuids": { "type": "array", "description": "The unique identifiers of the created media assets", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the created media assets", "xml": { "name": "uuid" } } } }, "xml": { "name": "createPartnerStyleMediaResponse" } }, "PartnerListingService_CloudinaryMediaInfo": { "required": [ "publicId", "signature", "uploadUrl", "version" ], "type": "object", "properties": { "publicId": { "type": "string", "description": "The public ID, as returned by Cloudinary" }, "signature": { "type": "string", "description": "The request signature, as returned by Cloudinary" }, "version": { "type": "string", "description": "The version, as returned by Cloudinary" }, "cropMode": { "type": "string", "description": "The crop mode", "enum": [ "NO_COORDINATES", "FACE_COORDINATES", "CUSTOM_COORDINATES" ] }, "uploadUrl": { "type": "string", "description": "The upload URL, as returned by Cloudinary" }, "originalFilename": { "type": "string", "description": "The original filename of the media uploaded to Cloudinary" }, "filenameOverride": { "type": "string", "description": "The filename override in Cloudinary" } }, "description": "Describes Cloudinary-specific info about a media asset", "xml": { "name": "cloudinaryMediaInfo" } }, "PartnerListingService_CreateMediaInfo": { "required": [ "mediaType", "positionOrdinal" ], "type": "object", "properties": { "mediaType": { "type": "string", "description": "The media type", "example": "PHOTO", "enum": [ "PHOTO", "VIDEO", "AUDIO", "DOCUMENT" ] }, "mediaFormat": { "type": "string", "description": "The media format. This value is required only if the media type = DOCUMENT", "example": "PDF" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal for the media in the list", "format": "int32", "example": 2 }, "originalName": { "type": "string", "description": "The media original name" }, "cropCoordinates": { "type": "array", "description": "A list of the crop coordinates of a PHOTO media item", "example": [ 146, 243, 932, 825 ], "xml": { "wrapped": true }, "items": { "type": "integer", "description": "A list of the crop coordinates of a PHOTO media item", "format": "int32", "xml": { "name": "cropCoordinate" } } }, "cloudinaryInfo": { "$ref": "#/components/schemas/PartnerListingService_CloudinaryMediaInfo" } }, "description": "The media assets to create and associate with the style", "xml": { "name": "createMediaInfo" } }, "PartnerListingService_CreatePartnerStyleMediaRequest": { "required": [ "mediaInfos" ], "type": "object", "properties": { "mediaInfos": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "The media assets to create and associate with the style", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_CreateMediaInfo" } }, "conflictActionOption": { "type": "string", "description": "How to handle the position ordinal conflicts: FAIL (default), REPLACE, FLUSH_AND_FILL, INSERT_AND_SHIFT, APPEND_TO_END" } }, "xml": { "name": "createPartnerStyleMediaRequest" } }, "PartnerListingService_UpdatePartnerStyleMediaResponse": { "required": [ "mediaUuids", "styleListingUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingUuid": { "type": "string", "description": "The unique code representing the update style listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "mediaUuids": { "type": "array", "description": "The unique code representing the media items that were updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique code representing the media items that were updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "mediaUuid" } } } }, "xml": { "name": "updatePartnerStyleMediaResponse" } }, "PartnerListingService_UpdateMediaInfo": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing the media item to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of this media item.", "format": "int32", "example": 2 }, "subjects": { "type": "array", "description": "The media subject codes", "example": "INDIVIDUAL_PRODUCT", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media subject codes", "example": "INDIVIDUAL_PRODUCT", "xml": { "name": "subject" } } }, "angles": { "type": "array", "description": "The media angle codes", "example": "FRONT", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media angle codes", "example": "FRONT", "xml": { "name": "angle" } } }, "backgrounds": { "type": "array", "description": "The media background codes", "example": "SOLID", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media background codes", "example": "SOLID", "xml": { "name": "background" } } }, "contentTypes": { "type": "array", "description": "The media content type codes", "example": "BRAND", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media content type codes", "example": "BRAND", "xml": { "name": "contentType" } } } }, "description": "The media assets to update for the style", "xml": { "name": "updateMediaInfo" } }, "PartnerListingService_UpdatePartnerStyleMediaRequest": { "required": [ "mediaUpdates" ], "type": "object", "properties": { "mediaUpdates": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "The media assets to update for the style", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerListingService_UpdateMediaInfo" } } }, "xml": { "name": "updatePartnerStyleMediaRequest" } }, "PartnerListingService_DeletePartnerStyleMediaResponse": { "required": [ "styleListingUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "styleListingUuid": { "type": "string", "description": "The unique identifier of the style listing, if the delete is successful" } }, "xml": { "name": "deletePartnerStyleMediaResponse" } }, "PartnerProfileService_GetAssociateInviteTokenInfoResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "inviteTokenIntendedEmailAddress": { "type": "string", "description": "The email address pertaining to this invitation token" } }, "xml": { "name": "getAssociateInviteTokenInfoResponse" } }, "PartnerProfileService_CreatePartnerInviteResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerInviteId": { "type": "string", "description": "The partner invite's unique universal id" } }, "xml": { "name": "createPartnerInviteResponse" } }, "PartnerProfileService_CreatePartnerInvite": { "required": [ "email", "firstName", "lastName", "legalEntityName", "successManagerId" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's first name.", "example": "Susan" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's last name.", "example": "Smith" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An associate's email.", "example": "susan.smith@gmail.com" }, "legalEntityName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Legal entity name", "example": "FLAMINGO DIAMOND INC" }, "successManagerId": { "maxLength": 38, "minLength": 1, "type": "string", "description": "Success manager id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "The partner invite to create", "xml": { "name": "createPartnerInvite" } }, "PartnerProfileService_CreatePartnerInviteRequest": { "required": [ "createPartnerInvite" ], "type": "object", "properties": { "createPartnerInvite": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerInvite" } }, "xml": { "name": "createPartnerInviteRequest" } }, "PartnerProfileService_GetPartnerInviteByUUIDResponse": { "required": [ "partnerInviteResult" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerInviteResult": { "$ref": "#/components/schemas/PartnerProfileService_PartnerInvite" } }, "xml": { "name": "getPartnerInviteByUUIDResponse" } }, "PartnerProfileService_PartnerInvite": { "required": [ "acceptedPartnerId", "email", "firstName", "invitedByFirstName", "invitedByLastName", "invitedOnDate", "lastName", "legalEntityName", "partnerInviteId", "partnerInviteStatus", "successManagerId" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's first name.", "example": "Susan" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's last name.", "example": "Smith" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An associate's email.", "example": "susan.smith@gmail.com" }, "partnerInviteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner invite's unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "invitedByFirstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The invited by's first name.", "example": "Susan" }, "invitedByLastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The invited by's last name.", "example": "Smith" }, "invitedOnDate": { "type": "string", "description": "The partner invite date", "format": "date-time", "example": "2016-03-28T12:26:21-04:00" }, "partnerInviteStatus": { "type": "string", "description": "Partner invite status", "example": "PENDING", "enum": [ "PENDING", "ACCEPTED", "CANCELLED", "EXPIRED" ] }, "acceptedPartnerId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The invite accepting partners unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "legalEntityName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Legal entity name", "example": "FLAMINGO DIAMOND INC" }, "successManagerId": { "maxLength": 38, "minLength": 1, "type": "string", "description": "Success manager id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "A list of partner invite with resulting partner", "xml": { "name": "partnerInvite" } }, "PartnerProfileService_GetPartnerInvitesResponse": { "required": [ "partnerInviteResults", "resultPageSize", "startingRecordIndex", "totalNumberOfRecords" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerInviteResults": { "type": "array", "description": "A list of partner invite with resulting partner", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerInvite" } }, "totalNumberOfRecords": { "type": "integer", "description": "Total number of results available on record", "format": "int32" }, "startingRecordIndex": { "type": "integer", "description": "Starting record index per all results on record", "format": "int32" }, "resultPageSize": { "type": "integer", "description": "The max number of records included in the paged invite history list", "format": "int32", "xml": { "name": "resultsPageSize" } } }, "xml": { "name": "cetPartnerInvitesResponse" } }, "PartnerProfileService_DeletePartnerInviteResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerInviteResponse" } }, "PartnerProfileService_GetPartnerInviteTokenInfoResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "inviteTokenIntendedEmailAddress": { "type": "string", "description": "The email address pertaining to this invitation token" } }, "xml": { "name": "getPartnerInviteTokenInfoResponse" } }, "PartnerProfileService_BasicPartnerProfile": { "required": [ "category", "defaultPartner", "legalEntityName", "operatingName", "partnerAccountStatus", "partnerId", "primaryContact" ], "type": "object", "properties": { "partnerId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner's unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "pricingProposalSummary": { "$ref": "#/components/schemas/PartnerProfileService_PricingProposalSummary" }, "primaryContact": { "$ref": "#/components/schemas/PartnerProfileService_PrimaryPartnerAssociate" }, "partnerAccountStatus": { "type": "string", "description": "Partner account status", "example": "REGISTRATION_IN_PROGRESS", "enum": [ "REGISTRATION_IN_PROGRESS", "REGISTRATION_COMPLETED", "ACTIVE", "DELETED", "INACTIVE", "SUSPENDED", "CLOSED" ] }, "legalEntityName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Legal entity name", "example": "FLAMINGO DIAMOND INC" }, "operatingName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Operating name", "example": "FLAMINGO DIAMOND" }, "category": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Context Category", "example": "All" }, "defaultPartner": { "type": "boolean", "description": "Default Partner", "example": false } }, "description": "Basic Partner resource representation.", "xml": { "name": "basicPartnerProfile" } }, "PartnerProfileService_GetPartnerProfilesResponse": { "required": [ "nextPage", "partnerProfiles" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerProfiles": { "type": "array", "description": "The partner profile list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_BasicPartnerProfile" } }, "nextPage": { "type": "boolean", "description": "Is the next page available" } }, "xml": { "name": "partnerProfilesResponse" } }, "PartnerProfileService_Phone": { "type": "object", "properties": { "countryCode": { "pattern": "^[0-9]{0,3}", "type": "string", "description": "Country code", "example": "1" }, "subscriberNumber": { "pattern": "^[0-9]{0,12}", "type": "string", "description": "The associate's phone number.", "example": "6155841898" }, "extension": { "pattern": "^[0-9]{0,5}", "type": "string", "description": "Optional phone extension", "example": "6155" } }, "description": "The associate's title.", "xml": { "name": "phone" } }, "PartnerProfileService_PricingProposalSummary": { "type": "object", "properties": { "numberOfRequests": { "type": "integer", "description": "The number of pending pricing proposal requests for this partner", "format": "int32", "example": 4 }, "dateRequested": { "type": "string", "description": "The date of the earliest requested pending pricing proposal", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "expirationDate": { "type": "string", "description": "The date of the earliest expiring pending pricing proposal", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Summary of pending supplier pricing proposals", "xml": { "name": "pricingProposalSummary" } }, "PartnerProfileService_PrimaryPartnerAssociate": { "required": [ "email", "firstName", "lastName", "partnerAssociateId" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's first name.", "example": "Susan" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's last name.", "example": "Smith" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An associate's email.", "example": "susan.smith@gmail.com" }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The associate's title.", "example": "VP of Buying" }, "phone": { "$ref": "#/components/schemas/PartnerProfileService_Phone" }, "partnerAssociateId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner's unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" } }, "description": "Partner primary contact", "xml": { "name": "primaryPartnerAssociate" } }, "PartnerProfileService_CreatePartnerResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerId": { "type": "string", "description": "The partner's unique universal partner id" } }, "xml": { "name": "createPartnerResponse" } }, "PartnerProfileService_CreatePartnerProfile": { "required": [ "category", "defaultPartner", "inviteToken", "legalEntityName", "operatingName", "partnerSites", "primaryContact" ], "type": "object", "properties": { "inviteToken": { "type": "string", "description": "The partner's invite token", "example": "eyJraWQiOiIxMGU5MzIxYi0wY2Y0LTQ2Y2YtYTAyMi04Y2I1MDA5YzU5OTEiLCJhbGciOiJIUzM4NCJ9.eyJpc3MiOiJKVFYiLCJpYXQiOjE1NTcxNTcwNTcsImV4cCI6MTU1NzE1ODI1Nywic3ViIjoiNjQxOGE2ZjItOGE2NS00YWQxLTg3ZDgtN2M2ZmExZGIxYWY3IiwicGFydG5lci11dWlkIjoiMTBkZmQ2OGEtOGIxOS00MzA1LTgzMzEtNmQzMGMyOGE1MmVmIn0.cCGTJBsLQNdGuAWgErtzUv2EVnYkp7YOOmp4wY86jIPwGXk0utB2A8_FleywP4L3" }, "primaryContact": { "$ref": "#/components/schemas/PartnerProfileService_CreatePrimaryPartnerAssociate" }, "partnerSites": { "type": "array", "description": "The partner's site list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PostPartnerSite" } }, "partnerAccountStatus": { "type": "string", "description": "Partner account status", "example": "REGISTRATION_IN_PROGRESS", "enum": [ "REGISTRATION_IN_PROGRESS", "REGISTRATION_COMPLETED", "ACTIVE", "DELETED", "INACTIVE", "SUSPENDED", "CLOSED" ] }, "legalEntityName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Legal entity name", "example": "FLAMINGO DIAMOND INC" }, "operatingName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Operating name", "example": "FLAMINGO DIAMOND" }, "category": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Context Category", "example": "All" }, "defaultPartner": { "type": "boolean", "description": "Default Partner", "example": false } }, "description": "The partner information.", "xml": { "name": "createPartnerProfile" } }, "PartnerProfileService_CreatePartnerProfileRequest": { "required": [ "createPartnerProfile" ], "type": "object", "properties": { "createPartnerProfile": { "$ref": "#/components/schemas/PartnerProfileService_CreatePartnerProfile" } }, "xml": { "name": "createPartnerProfileRequest" } }, "PartnerProfileService_CreatePrimaryPartnerAssociate": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's first name.", "example": "Susan" }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The associate's last name.", "example": "Smith" }, "email": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "An associate's email.", "example": "susan.smith@gmail.com" }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The associate's title.", "example": "VP of Buying" }, "phone": { "$ref": "#/components/schemas/PartnerProfileService_Phone" } }, "description": "Partner primary contact", "xml": { "name": "createPrimaryPartnerAssociate" } }, "PartnerProfileService_PartnerSiteUsage": { "required": [ "defaultForUsage", "partnerSiteUsageType" ], "type": "object", "properties": { "partnerSiteUsageType": { "type": "string", "description": "Partner site usage type", "example": "RETURNS", "enum": [ "BUSINESS", "RETURNS", "SHIPPING", "CUSTOMER_SHIPPING", "CUSTOMER_RETURNS" ] }, "defaultForUsage": { "type": "boolean", "description": "Default for site usage" } }, "description": "List of address usages.", "xml": { "name": "partnerSiteUsage" } }, "PartnerProfileService_PostPartnerSite": { "required": [ "address", "partnerSiteUsageList" ], "type": "object", "properties": { "siteName": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Site name", "example": "Headquarters" }, "poPostalCode": { "maxLength": 10, "minLength": 0, "pattern": "^[0-9]{5}(?:-[0-9]{4})?$", "type": "string", "description": "The postal code of the post office that will be used as the USPS drop off location", "example": "37922-6748" }, "partnerSiteUsageList": { "type": "array", "description": "List of address usages.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerSiteUsage" } }, "partnerSiteUsageTypes": { "type": "array", "description": "List of address usage types. Examples: 'BUSINESS','RETURNS','SHIPPING','CUSTOMER_RETURNS','CUSTOMER_SHIPPING'", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of address usage types. Examples: 'BUSINESS','RETURNS','SHIPPING','CUSTOMER_RETURNS','CUSTOMER_SHIPPING'", "xml": { "name": "partnerSiteUsageTypes" }, "enum": [ "BUSINESS", "RETURNS", "SHIPPING", "CUSTOMER_SHIPPING", "CUSTOMER_RETURNS" ] } }, "address": { "$ref": "#/components/schemas/PartnerProfileService_SiteAddress" } }, "description": "The partner site to create", "xml": { "name": "postPartnerSite" } }, "PartnerProfileService_SiteAddress": { "required": [ "addressLineOne", "city", "countryIso3Code", "postalCode", "subdivisionIsoCode" ], "type": "object", "properties": { "addressLineOne": { "maxLength": 240, "minLength": 0, "type": "string", "description": "First line of the address", "example": "9600 Parkside Drive" }, "addressLineTwo": { "maxLength": 240, "minLength": 0, "type": "string", "description": "Optional second line of the address", "example": "ATTN: Information Technology" }, "addressLineThree": { "maxLength": 240, "minLength": 0, "type": "string", "description": "Optional third line of the address", "example": "Room: P132" }, "city": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Address city", "example": "Knoxville" }, "postalCode": { "maxLength": 16, "minLength": 0, "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922" }, "subdivisionIsoCode": { "maxLength": 6, "minLength": 0, "pattern": "^[A-Z0-9-]{0,6}$", "type": "string", "description": "State/Province/Administrative Area Code", "example": "US-TN" }, "countryIso3Code": { "maxLength": 3, "minLength": 0, "pattern": "^[A-Z]{3}$", "type": "string", "description": "Address Country Abbreviation", "example": "USA" } }, "description": "Address for partner site", "xml": { "name": "siteAddress" } }, "PartnerProfileService_UpdatePartnerResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updatePartnerResponse" } }, "PartnerProfileService_PostPartnerProfileSite": { "required": [ "address", "partnerSiteUsageList", "siteId" ], "type": "object", "properties": { "siteName": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Site name", "example": "Headquarters" }, "poPostalCode": { "maxLength": 10, "minLength": 0, "pattern": "^[0-9]{5}(?:-[0-9]{4})?$", "type": "string", "description": "The postal code of the post office that will be used as the USPS drop off location", "example": "37922-6748" }, "partnerSiteUsageList": { "type": "array", "description": "List of address usages.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerSiteUsage" } }, "partnerSiteUsageTypes": { "type": "array", "description": "List of address usage types. Examples: 'BUSINESS','RETURNS','SHIPPING','CUSTOMER_RETURNS','CUSTOMER_SHIPPING'", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of address usage types. Examples: 'BUSINESS','RETURNS','SHIPPING','CUSTOMER_RETURNS','CUSTOMER_SHIPPING'", "xml": { "name": "partnerSiteUsageTypes" }, "enum": [ "BUSINESS", "RETURNS", "SHIPPING", "CUSTOMER_SHIPPING", "CUSTOMER_RETURNS" ] } }, "address": { "$ref": "#/components/schemas/PartnerProfileService_SiteAddress" }, "siteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner's unique universal site id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "The partner's site list", "xml": { "name": "postPartnerProfileSite" } }, "PartnerProfileService_UpdatePartnerProfile": { "required": [ "category", "defaultPartner", "legalEntityName", "operatingName", "partnerAccountStatus", "partnerSites", "primaryContact" ], "type": "object", "properties": { "primaryContact": { "$ref": "#/components/schemas/PartnerProfileService_PrimaryPartnerAssociate" }, "partnerSites": { "type": "array", "description": "The partner's site list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PostPartnerProfileSite" } }, "partnerAccountStatus": { "type": "string", "description": "Partner account status", "example": "REGISTRATION_IN_PROGRESS", "enum": [ "REGISTRATION_IN_PROGRESS", "REGISTRATION_COMPLETED", "ACTIVE", "DELETED", "INACTIVE", "SUSPENDED", "CLOSED" ] }, "legalEntityName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Legal entity name", "example": "FLAMINGO DIAMOND INC" }, "operatingName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Operating name", "example": "FLAMINGO DIAMOND" }, "category": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Context Category", "example": "All" }, "defaultPartner": { "type": "boolean", "description": "Default Partner", "example": false } }, "description": "Partner profile update resource representation.", "xml": { "name": "UpdatePartnerProfile" } }, "PartnerProfileService_UpdatePartnerRequest": { "required": [ "updatePartner" ], "type": "object", "properties": { "updatePartner": { "$ref": "#/components/schemas/PartnerProfileService_UpdatePartnerProfile" } }, "xml": { "name": "updatePartnerRequest" } }, "PartnerProfileService_GetPartnerResponse": { "required": [ "partner" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partner": { "$ref": "#/components/schemas/PartnerProfileService_PartnerProfile" } }, "xml": { "name": "partnerResponse" } }, "PartnerProfileService_PartnerProfile": { "required": [ "category", "defaultPartner", "legalEntityName", "operatingName", "partnerAccountStatus", "partnerId", "partnerSites", "primaryContact" ], "type": "object", "properties": { "partnerId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner's unique universal id", "example": "183f9087-dd8c-5184-d1e6-6c47bfb6b312" }, "pricingProposalSummary": { "$ref": "#/components/schemas/PartnerProfileService_PricingProposalSummary" }, "primaryContact": { "$ref": "#/components/schemas/PartnerProfileService_PrimaryPartnerAssociate" }, "partnerSites": { "type": "array", "description": "The partner's site list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerSite" } }, "partnerAccountStatus": { "type": "string", "description": "Partner account status", "example": "REGISTRATION_IN_PROGRESS", "enum": [ "REGISTRATION_IN_PROGRESS", "REGISTRATION_COMPLETED", "ACTIVE", "DELETED", "INACTIVE", "SUSPENDED", "CLOSED" ] }, "legalEntityName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Legal entity name", "example": "FLAMINGO DIAMOND INC" }, "operatingName": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Operating name", "example": "FLAMINGO DIAMOND" }, "category": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Context Category", "example": "All" }, "defaultPartner": { "type": "boolean", "description": "Default Partner", "example": false } }, "description": "Partner resource representation.", "xml": { "name": "partnerProfile" } }, "PartnerProfileService_PartnerSite": { "required": [ "active", "address", "partnerSiteUsageList", "siteId" ], "type": "object", "properties": { "siteName": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Site name", "example": "Headquarters" }, "poPostalCode": { "maxLength": 10, "minLength": 0, "pattern": "^[0-9]{5}(?:-[0-9]{4})?$", "type": "string", "description": "The postal code of the post office that will be used as the USPS drop off location", "example": "37922-6748" }, "partnerSiteUsageList": { "type": "array", "description": "List of address usages.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerSiteUsage" } }, "partnerSiteUsageTypes": { "type": "array", "description": "List of address usage types. Examples: 'BUSINESS','RETURNS','SHIPPING','CUSTOMER_RETURNS','CUSTOMER_SHIPPING'", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of address usage types. Examples: 'BUSINESS','RETURNS','SHIPPING','CUSTOMER_RETURNS','CUSTOMER_SHIPPING'", "xml": { "name": "partnerSiteUsageTypes" }, "enum": [ "BUSINESS", "RETURNS", "SHIPPING", "CUSTOMER_SHIPPING", "CUSTOMER_RETURNS" ] } }, "siteId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The partner's unique universal site id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "address": { "$ref": "#/components/schemas/PartnerProfileService_SiteAddress" }, "active": { "type": "boolean", "description": "Partner site active flag" } }, "description": "The partner site", "xml": { "name": "partnerSite" } }, "PartnerProfileService_UpdatePartnerSiteResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updatePartnerSiteResponse" } }, "PartnerProfileService_UpdatePartnerSiteRequest": { "required": [ "updatePartnerSite" ], "type": "object", "properties": { "updatePartnerSite": { "$ref": "#/components/schemas/PartnerProfileService_PostPartnerSite" } }, "xml": { "name": "updatePartnerSiteRequest" } }, "PartnerProfileService_CreatePartnerSiteResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerSiteId": { "type": "string", "description": "The partner site's unique universal partner id" } }, "xml": { "name": "createPartnerSiteResponse" } }, "PartnerProfileService_CreatePartnerSiteRequest": { "required": [ "createPartnerSite" ], "type": "object", "properties": { "createPartnerSite": { "$ref": "#/components/schemas/PartnerProfileService_PostPartnerSite" } }, "xml": { "name": "createSubPartnerRequest" } }, "PartnerProfileService_DeletePartnerSiteResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerSiteResponse" } }, "PartnerProfileService_GetPartnerSitesResponse": { "required": [ "partnerSites" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerSites": { "type": "array", "description": "A list of partner sites", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerSite" } } }, "xml": { "name": "getPartnerSitesResponse" } }, "PartnerProfileService_GetPartnerSiteResponse": { "required": [ "partnerSite" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerSite": { "$ref": "#/components/schemas/PartnerProfileService_PartnerSite" } }, "xml": { "name": "partnerSiteResponse" } }, "PartnerReceiptService_CreateReceiptHeaderResponse": { "required": [ "receiptHeaderId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptHeaderId": { "type": "string", "description": "The unique code representing the receipt header created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createReceiptHeaderResponse" } }, "PartnerReceiptService_CreatePartnerReceiptHeaderRequest": { "required": [ "shipmentId" ], "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Shipment ID for Return.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "returnTrackingNumber": { "type": "string", "description": "Tracking Number on Return Label.", "example": "123456789" } }, "xml": { "name": "createPartnerReceiptHeaderRequest" } }, "PartnerReceiptService_UpdateReceiptHeaderResponse": { "required": [ "receiptHeaderId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptHeaderId": { "type": "string", "description": "The unique code representing the receipt header updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "updateReceiptHeaderResponse" } }, "PartnerReceiptService_UpdatePartnerReceiptHeaderRequest": { "required": [ "receiptHeaderStatus" ], "type": "object", "properties": { "receiptHeaderStatus": { "type": "string", "description": "Status to update the receipt header with.", "example": "CONFIRMED", "enum": [ "CONFIRMED" ] }, "returnTrackingNumber": { "type": "string", "description": "Tracking Number on Return Label.", "example": "123456789" } }, "xml": { "name": "updatePartnerReceiptHeaderRequest" } }, "PartnerReceiptService_CustomerInformation": { "type": "object", "properties": { "customerId": { "type": "string", "description": "The customer's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "customerFirstName": { "type": "string", "description": "The customer's first name.", "example": "Susan" }, "customerLastName": { "type": "string", "description": "The customer's last name.", "example": "Smith" } }, "description": "Describes customer information", "xml": { "name": "customerInformation" } }, "PartnerReceiptService_GetReceiptHeadersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "filteredListCount": { "type": "integer", "description": "The number of receipts headers that passed any active filters.", "format": "int32" }, "totalListCount": { "type": "integer", "description": "The total number of receipt headers for this partner, without any filters.", "format": "int32" }, "receiptHeaders": { "type": "array", "description": "The paged list of receipt headers that satisfy the filter criteria.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerReceiptService_ReceiptHeader" } } }, "xml": { "name": "getReceiptHeadersResponse" } }, "PartnerReceiptService_OrderHeaderInformation": { "required": [ "orderHeaderId", "orderNumber", "orderTotalLineCount", "orderTotalLineQuantity" ], "type": "object", "properties": { "orderHeaderId": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderNumber": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderDateTime": { "type": "string", "description": "Order Header Creation Date", "format": "date-time" }, "originalOrderInformation": { "$ref": "#/components/schemas/PartnerReceiptService_OriginalOrder" }, "orderStatus": { "$ref": "#/components/schemas/PartnerReceiptService_OrderHeaderOrderStatus" }, "customerInformation": { "$ref": "#/components/schemas/PartnerReceiptService_CustomerInformation" }, "orderTotalLineCount": { "type": "integer", "description": "Order Total Line Count", "format": "int32" }, "orderTotalLineQuantity": { "type": "integer", "description": "Order Total Quantity", "format": "int32" }, "orderGrandTotalValue": { "type": "number", "description": "Order Grand Total Value", "format": "float" } }, "description": "Describes order header information", "xml": { "name": "orderHeaderInformation" } }, "PartnerReceiptService_OrderHeaderOrderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Order Status Code" }, "name": { "type": "string", "description": "Order Status Name" }, "description": { "type": "string", "description": "Order Status Description" } }, "description": "Order Status", "xml": { "name": "OrderStatus" } }, "PartnerReceiptService_OriginalOrder": { "required": [ "orderHeaderId", "orderNumber" ], "type": "object", "properties": { "orderHeaderId": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" }, "orderNumber": { "type": "string", "description": "Partner Customer Order Ref Number", "example": "8675309" } }, "description": "Return Order's Original Order Information", "xml": { "name": "OriginalOrderInformation" } }, "PartnerReceiptService_PartnerReceiptCustomerInfo": { "required": [ "customerFirstName", "customerLastName" ], "type": "object", "properties": { "customerUuid": { "type": "string", "description": "The customer id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "customerId" } }, "customerFirstName": { "type": "string", "description": "The Customer First Name", "example": "Holly" }, "customerLastName": { "type": "string", "description": "The Customer Last Name", "example": "Golightly" } }, "description": "The receipt line customer info", "xml": { "name": "customerInfo" } }, "PartnerReceiptService_PartnerReceiptLine": { "required": [ "createdDateTime" ], "type": "object", "properties": { "receiptLineUuid": { "type": "string", "description": "The receipt line id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentLineUuid": { "type": "string", "description": "The shipment line id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentHeaderUuid": { "type": "string", "description": "The shipment header id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "receiptLineNumber": { "type": "integer", "description": "The receipt line number.", "format": "int32", "example": 1 }, "createdDateTime": { "type": "string", "description": "The date for the package status.", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "receiptLineStatus": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineStatus" }, "receiptLineType": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineType" }, "receiptLineReason": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineReason" }, "receiptCustomerInfo": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptCustomerInfo" }, "exchangeSkuNumber": { "type": "string", "description": "The receipt line exchange sku number." }, "exchangeSkuSize": { "type": "string", "description": "The receipt line exchange sku size." }, "receiptLineQuantity": { "type": "integer", "description": "The receipt line quantity.", "format": "int32" }, "styleNumber": { "type": "string", "description": "The receipt line style number." }, "supplierStyleNumber": { "type": "string", "description": "The receipt line supplier style number." }, "styleImageUrl": { "type": "string", "description": "The receipt line style image url." }, "styleTitleDescription": { "type": "string", "description": "The receipt line style title description." }, "skuNumber": { "type": "string", "description": "The receipt line sku number." }, "supplierSkuNumber": { "type": "string", "description": "The receipt line supplier sku number." }, "sizeValue": { "type": "string", "description": "The receipt line size value." }, "orderLinePrice": { "type": "number", "description": "The receipt line price." }, "returnCreditValue": { "type": "number", "description": "The receipt line return credit value." }, "returnOrderNumber": { "type": "integer", "description": "The return order number.", "format": "int64" } }, "description": "a list of receipt lines", "xml": { "name": "receiptLine" } }, "PartnerReceiptService_PartnerReceiptLineReason": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the receipt line reason.", "example": "Receipt Line Reason Code" }, "name": { "type": "string", "description": "The name of the receipt line reason.", "example": "Receipt Line Reason Name" }, "description": { "type": "string", "description": "The description of the receipt line reason.", "example": "Receipt Line Reason Description" }, "displayOrder": { "type": "integer", "description": "The display order of the receipt line reason.", "format": "int32" }, "receiptLineReasonGroup": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineReasonGroup" } }, "description": "The receipt line reason.", "xml": { "name": "receiptLineReason" } }, "PartnerReceiptService_PartnerReceiptLineReasonGroup": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the receipt line reason group.", "example": "Receipt Line Reason Group Code" }, "name": { "type": "string", "description": "The name of the receipt line reason group.", "example": "Receipt Line Reason Group Nane" }, "description": { "type": "string", "description": "The description of the receipt line reason group.", "example": "Receipt Line Reason Group Description" }, "displayOrder": { "type": "integer", "description": "The display order of the receipt line reason group.", "format": "int32" } }, "description": "The group of the receipt line reason.", "example": "Receipt Line Reason Group", "xml": { "name": "receiptLineReasonGroup" } }, "PartnerReceiptService_PartnerReceiptLineStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the receipt line status.", "example": "Receipt Line Status Code" }, "name": { "type": "string", "description": "The name of the receipt line status.", "example": "Receipt Line Status Name" }, "description": { "type": "string", "description": "The description of the receipt line status.", "example": "Receipt Line Status Description" }, "displayOrder": { "type": "integer", "description": "The display order of the receipt line status.", "format": "int32" }, "receiptLineStatusClass": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineStatusClass" } }, "description": "The receipt line status.", "xml": { "name": "receiptLineStatus" } }, "PartnerReceiptService_PartnerReceiptLineStatusClass": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the receipt line status class.", "example": "Receipt Line Status Class Code" }, "name": { "type": "string", "description": "The name of the receipt line status class.", "example": "Receipt Line Status Class Name" }, "description": { "type": "string", "description": "The description of the receipt line status class.", "example": "Receipt Line Status Class Description" }, "displayOrder": { "type": "integer", "description": "The display order of the receipt line status class.", "format": "int32" } }, "description": "The status class of the receipt line status.", "example": "Receipt Line Status Class", "xml": { "name": "receiptLineStatusClass" } }, "PartnerReceiptService_PartnerReceiptLineType": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the receipt line type.", "example": "Receipt Line Type Code" }, "name": { "type": "string", "description": "The name of the receipt line type.", "example": "Receipt Line Type Name" }, "description": { "type": "string", "description": "The description of the receipt line type.", "example": "Receipt Line Type Description" }, "displayOrder": { "type": "integer", "description": "The display order of the receipt line type.", "format": "int32" } }, "description": "The receipt line type.", "xml": { "name": "receiptLineType" } }, "PartnerReceiptService_ReceiptHeader": { "type": "object", "properties": { "receiptHeaderId": { "type": "string", "description": "The receipt header's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "receiptNumber": { "type": "string", "description": "The receipt number", "example": "SCPPALWCRU-001" }, "receiptStatus": { "$ref": "#/components/schemas/PartnerReceiptService_ReceiptStatus" }, "receiptReturnLabelType": { "$ref": "#/components/schemas/PartnerReceiptService_ReceiptReturnLabelType" }, "shipmentId": { "type": "string", "description": "The related shipment's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "createdDateTime": { "type": "string", "description": "The receipt creation date", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "trackingNumber": { "type": "string", "description": "The receipt tracking number" }, "customerInformation": { "$ref": "#/components/schemas/PartnerReceiptService_CustomerInformation" }, "receiptSummaryInformation": { "$ref": "#/components/schemas/PartnerReceiptService_ReceiptSummaryInformation" }, "receiptReturnOrders": { "type": "array", "description": "List of receipt return orders", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerReceiptService_ReceiptReturnOrder" } }, "receiptLineList": { "type": "array", "description": "List of partner receipt lines", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLine" } } }, "description": "Describes receipt header", "xml": { "name": "receiptHeader" } }, "PartnerReceiptService_ReceiptReturnLabelType": { "type": "object", "properties": { "code": { "type": "string", "description": "The receipt return label type code", "example": "PLATFORM_PROVIDED_SERVICE" }, "name": { "type": "string", "description": "The receipt return label type name", "example": "Platform Provided Service" }, "description": { "type": "string", "description": "The receipt return label type description", "example": "The return label was purchased by the platform and provided to the customer." } }, "description": "Describes receipt return label type", "xml": { "name": "ReceiptReturnLabelType" } }, "PartnerReceiptService_ReceiptReturnOrder": { "type": "object", "properties": { "orderHeaderInformation": { "$ref": "#/components/schemas/PartnerReceiptService_OrderHeaderInformation" } }, "description": "List of receipt return orders", "xml": { "name": "ReceiptReturnOrder" } }, "PartnerReceiptService_ReceiptStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "The receipt status code", "example": "PENDING_CONFIRMATION" }, "name": { "type": "string", "description": "The receipt status name", "example": "Pending Confirmation" }, "description": { "type": "string", "description": "The receipt status description", "example": "The receipt has been created and is pending confirmation." } }, "description": "Describes receipt status", "xml": { "name": "receiptStatus" } }, "PartnerReceiptService_ReceiptSummaryInformation": { "type": "object", "properties": { "totalValue": { "type": "number", "description": "The receipt total dollar value", "format": "double", "example": 95.99 }, "totalOrderLineCount": { "type": "integer", "description": "The receipt line count", "format": "int32", "example": 2 }, "totalOrderLineQuantity": { "type": "integer", "description": "The receipt total quantity", "format": "int32", "example": 10 } }, "description": "Describes receipt summary information", "xml": { "name": "receiptSummaryInformation" } }, "PartnerReceiptService_GetReceiptHeaderResponse": { "required": [ "receiptHeader" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptHeader": { "$ref": "#/components/schemas/PartnerReceiptService_ReceiptHeader" } }, "xml": { "name": "getReceiptHeaderResponse" } }, "PartnerReceiptService_CancelReceiptHeaderResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "cancelReceiptHeaderResponse" } }, "PartnerReceiptService_CancelPartnerReceiptHeaderRequest": { "required": [ "cancelReasonCode" ], "type": "object", "properties": { "cancelReasonCode": { "type": "string", "description": "The reason code for order cancellation" } }, "xml": { "name": "cancelPartnerReceiptHeaderRequest" } }, "PartnerReceiptService_GetReceiptLineDetailResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerReceiptLineDetail": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineDetail" } }, "xml": { "name": "getReceiptLineDetailResponse" } }, "PartnerReceiptService_PartnerReceiptCreateUserInfo": { "required": [ "createdOn", "firstName", "lastName" ], "type": "object", "properties": { "userName": { "type": "string", "description": "The user name.", "example": "user@foo.com" }, "firstName": { "type": "string", "description": "The Create User First Name", "example": "Joe" }, "lastName": { "type": "string", "description": "The Create User Last Name", "example": "Sheet", "xml": { "name": "customerLastName" } }, "createdOn": { "type": "string", "description": "The date for receipt line creation.", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" } }, "description": "The receipt line create information.", "xml": { "name": "createInformation" } }, "PartnerReceiptService_PartnerReceiptLineDetail": { "required": [ "createdDateTime" ], "type": "object", "properties": { "receiptLineUuid": { "type": "string", "description": "The receipt line id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentLineUuid": { "type": "string", "description": "The shipment line id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentHeaderUuid": { "type": "string", "description": "The shipment header id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "receiptLineNumber": { "type": "integer", "description": "The receipt line number.", "format": "int32", "example": 1 }, "createdDateTime": { "type": "string", "description": "The date for the package status.", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" }, "receiptLineStatus": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineStatus" }, "receiptLineType": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineType" }, "receiptLineReason": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLineReason" }, "receiptCustomerInfo": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptCustomerInfo" }, "exchangeSkuNumber": { "type": "string", "description": "The receipt line exchange sku number." }, "exchangeSkuSize": { "type": "string", "description": "The receipt line exchange sku size." }, "receiptLineQuantity": { "type": "integer", "description": "The receipt line quantity.", "format": "int32" }, "styleNumber": { "type": "string", "description": "The receipt line style number." }, "supplierStyleNumber": { "type": "string", "description": "The receipt line supplier style number." }, "styleImageUrl": { "type": "string", "description": "The receipt line style image url." }, "styleTitleDescription": { "type": "string", "description": "The receipt line style title description." }, "skuNumber": { "type": "string", "description": "The receipt line sku number." }, "supplierSkuNumber": { "type": "string", "description": "The receipt line supplier sku number." }, "sizeValue": { "type": "string", "description": "The receipt line size value." }, "orderLinePrice": { "type": "number", "description": "The receipt line price." }, "returnCreditValue": { "type": "number", "description": "The receipt line return credit value." }, "returnOrderNumber": { "type": "integer", "description": "The return order number.", "format": "int64" }, "createInformation": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptCreateUserInfo" }, "updateInformation": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptUpdateUserInfo" }, "returnOrderInfo": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptReturnOrderInfo" } }, "xml": { "name": "receiptLineDetail" } }, "PartnerReceiptService_PartnerReceiptReturnOrderInfo": { "type": "object", "properties": { "orderHeaderId": { "type": "integer", "description": "The return order header ID.", "format": "int64" }, "orderHeaderNumber": { "type": "integer", "description": "The return order header number.", "format": "int64" }, "orderLineId": { "type": "integer", "description": "The return order line ID.", "format": "int64" }, "orderLineNumber": { "type": "integer", "description": "The return order line number.", "format": "int64" } }, "description": "The return order info.", "xml": { "name": "returnOrderInfo" } }, "PartnerReceiptService_PartnerReceiptUpdateUserInfo": { "required": [ "firstName", "lastName", "updatedOn" ], "type": "object", "properties": { "userName": { "type": "string", "description": "The update user name.", "example": "user@foo.com" }, "firstName": { "type": "string", "description": "The Update User First Name", "example": "Joe" }, "lastName": { "type": "string", "description": "The Update User Last Name", "example": "Sheet", "xml": { "name": "customerLastName" } }, "updatedOn": { "type": "string", "description": "The date for receipt line update.", "format": "date-time", "example": "2019-03-28T12:26:21-04:00" } }, "description": "The receipt line update information.", "xml": { "name": "updateInformation" } }, "PartnerReceiptService_CancelReceiptLineResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "cancelReceiptLineResponse" } }, "PartnerReceiptService_CancelPartnerReceiptLineRequest": { "required": [ "cancelReasonCode" ], "type": "object", "properties": { "cancelReasonCode": { "type": "string", "description": "The reason code for order cancellation" } }, "xml": { "name": "cancelPartnerReceiptLineRequest" } }, "PartnerReceiptService_CreateReceiptLineResponse": { "required": [ "receiptLineId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "receiptLineId": { "type": "string", "description": "The unique code representing the receipt line created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createReceiptLineResponse" } }, "PartnerReceiptService_CreatePartnerReceiptLineRequest": { "required": [ "quantity", "returnReasonCode", "returnTypeCode", "shipmentLineId" ], "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "Shipment line id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "type": "integer", "description": "The return quantity", "format": "int32" }, "returnReasonCode": { "type": "string", "description": "The code representing the return reason" }, "returnTypeCode": { "type": "string", "description": "The code representing the return type", "enum": [ "EXCHANGE", "REFUND", "REPAIR" ] }, "exchangeSkuNumber": { "type": "string", "description": "SKU Number for exchange" } }, "xml": { "name": "createPartnerReceiptLineRequest" } }, "PartnerReceiptService_UpdateReceiptLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerReceiptLineIds": { "type": "array", "description": "a list of receipt line ids", "items": { "type": "string", "description": "a list of receipt line ids" } } }, "xml": { "name": "updateReceiptLinesResponse" } }, "PartnerReceiptService_PartnerReceiptUpdateLine": { "required": [ "receiptLineId" ], "type": "object", "properties": { "receiptLineId": { "type": "string", "description": "The receipt line id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "receiptLineTypeCode": { "type": "string", "description": "The receipt line return type.", "enum": [ "EXCHANGE", "REFUND", "REPAIR" ] }, "receiptLineReasonCode": { "type": "string", "description": "The code representing the return reason", "example": "1401" }, "exchangeSkuNumber": { "type": "string", "description": "The receipt line exchange sku number.", "example": "DQK998-7" }, "receiptLineQuantity": { "minimum": 0, "type": "integer", "description": "The receipt line quantity.", "format": "int32", "example": 1 } }, "description": "The receipt lines to be updated", "xml": { "name": "receiptUpdateLine" } }, "PartnerReceiptService_UpdatePartnerReceiptLinesRequest": { "required": [ "receiptLines" ], "type": "object", "properties": { "receiptLines": { "type": "array", "description": "The receipt lines to be updated", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptUpdateLine" } } }, "xml": { "name": "updatePartnerReceiptLinesRequest" } }, "PartnerReceiptService_GetReceiptLinesResponse": { "required": [ "partnerReceiptLines" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerReceiptLines": { "type": "array", "description": "a list of receipt lines", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerReceiptService_PartnerReceiptLine" } } }, "xml": { "name": "getReceiptLinesResponse" } }, "PartnerShipmentService_GetInventoryShipmentHeadersResponse": { "required": [ "filteredListCount", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "filteredListCount": { "type": "integer", "description": "The shipment header filtered list count", "format": "int32" }, "totalListCount": { "type": "integer", "description": "Total shipment header list count", "format": "int32" }, "shipmentHeaders": { "type": "array", "description": "List of shipment headers", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentHeader" } } }, "xml": { "name": "getInventoryShipmentHeadersResponse" } }, "PartnerShipmentService_InventoryPackageHeader": { "required": [ "packageId", "packageNumber", "packageOrdinal", "packageStatus", "skuCount", "totalQuantity" ], "type": "object", "properties": { "packageId": { "type": "string", "description": "The unique code representing an existing package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageOrdinal": { "type": "integer", "description": "The ordinal of this package within the shipment.", "format": "int32", "example": 3 }, "packageNumber": { "type": "string", "description": "The number of the package." }, "packageStatus": { "$ref": "#/components/schemas/PartnerShipmentService_PackageStatus" }, "skuCount": { "type": "integer", "description": "The number of SKUs having quantity within the package.", "format": "int32" }, "totalQuantity": { "type": "integer", "description": "The total item quantity of within the package.", "format": "int32" }, "createdDate": { "type": "string", "description": "The create date for this shipment.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The expected delivery date of this shipment.", "format": "date-time" } }, "description": "The package headers for this shipment.", "xml": { "name": "packageHeader" } }, "PartnerShipmentService_InventoryShipmentSummary": { "required": [ "totalPackageCount", "totalShipmentLineCount", "totalShipmentLineQuantity", "totalValue" ], "type": "object", "properties": { "totalValue": { "type": "number", "description": "The shipment total dollar value", "format": "double", "example": 95.99 }, "totalShipmentLineCount": { "type": "integer", "description": "The total shipment line count", "format": "int32", "example": 2 }, "totalShipmentLineQuantity": { "type": "integer", "description": "The total shipment line quantity", "format": "int32", "example": 10 }, "totalPackageCount": { "type": "integer", "description": "The total shipment package count", "format": "int32", "example": 10 }, "totalStyleCount": { "type": "integer", "description": "The total shipment style count", "format": "int32", "example": 10 } }, "description": "The inventory shipment summary.", "xml": { "name": "inventoryShipmentSummary" } }, "PartnerShipmentService_OrderStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing order status.", "example": "PROCESSING" }, "name": { "type": "string", "description": "The name representing the order status.", "example": "Processing" }, "description": { "type": "string", "description": "The description for the order status.", "example": "The order is currently processing." } }, "description": "The order status.", "xml": { "name": "orderStatus" } }, "PartnerShipmentService_OrderType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing order type.", "example": "PARTNER_REPLENISH_ORDER" }, "name": { "type": "string", "description": "The name representing the order type.", "example": "Partner Replenish Order" }, "description": { "type": "string", "description": "The description for the order type.", "example": "The Partner Replenish Order is the type of order used by Partners to request that inventory be replenished and shipped to a distribution center." } }, "description": "The order type.", "xml": { "name": "orderType" } }, "PartnerShipmentService_PackageStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing package status.", "example": "DELIVERED" }, "name": { "type": "string", "description": "The name representing the package status.", "example": "Delivered" }, "description": { "type": "string", "description": "The description for the package status.", "example": "Delivered" } }, "description": "The status of the package.", "xml": { "name": "packageStatus" } }, "PartnerShipmentService_ShipmentHeader": { "required": [ "partnerId", "partnerOperatingName", "shipmentHeaderId", "shipmentNumber", "shipmentStatus", "shipmentStatusClassification", "shipmentSummary" ], "type": "object", "properties": { "shipmentHeaderId": { "type": "string", "description": "The unique code representing an existing shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentNumber": { "type": "string", "description": "The number of the shipment." }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatus" }, "shipmentStatusClassification": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatusClassification" }, "shipmentSummary": { "$ref": "#/components/schemas/PartnerShipmentService_InventoryShipmentSummary" }, "partnerId": { "type": "string", "description": "The id of the partner.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "partnerOperatingName": { "type": "string", "description": "The name of the package." }, "orderHeader": { "$ref": "#/components/schemas/PartnerOrderService_OrderHeader" }, "expectedDeliveryDate": { "type": "string", "description": "The expected delivery date of this shipment.", "format": "date-time" }, "packageHeaders": { "type": "array", "description": "The package headers for this shipment.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_InventoryPackageHeader" } } }, "description": "List of shipment headers", "xml": { "name": "shipmentHeader" } }, "PartnerShipmentService_ShipmentStatus": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing shipment status.", "example": "DELIVERED" }, "name": { "type": "string", "description": "The name representing shipment status.", "example": "Delivered" } }, "description": "The shipment status.", "xml": { "name": "shipmentStatus" } }, "PartnerShipmentService_ShipmentStatusClassification": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing shipment status classification.", "example": "COMPLETE" }, "name": { "type": "string", "description": "The name representing shipment status classification.", "example": "Complete" } }, "description": "The shipment status classification.", "xml": { "name": "shipmentStatusClassification" } }, "PartnerShipmentService_GetInventoryShipmentLineResponse": { "required": [ "shipmentHeaderId", "shipmentLine" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderId": { "type": "string", "description": "The unique code representing an existing shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentLine": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentLine" } }, "xml": { "name": "getInventoryShipmentLineResponse" } }, "PartnerShipmentService_ShipmentLine": { "required": [ "lineNumber", "quantity", "quantityPicked", "shipmentLineId", "shipmentLineStatus", "skuNumber", "styleNumber", "totalPrice" ], "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "The UUID of the shipment line." }, "lineNumber": { "type": "integer", "description": "The line number.", "format": "int32" }, "styleListingId": { "type": "string", "description": "The product style external id (it is master sku in the old product model taxonomy)", "example": "DQK998Y", "xml": { "name": "styleId" } }, "styleNumber": { "type": "string", "description": "The style number." }, "styleImageUrl": { "type": "string", "description": "The image URL of the style." }, "styleTitleDescription": { "type": "string", "description": "The title description of the style." }, "skuNumber": { "type": "string", "description": "The SKU number." }, "supplierSkuNumber": { "type": "string", "description": "The supplier SKU number." }, "skuSize": { "type": "string", "description": "The size of the SKU." }, "quantity": { "type": "integer", "description": "The quantity ordered of the SKU.", "format": "int32" }, "quantityPicked": { "type": "integer", "description": "The quantity of the SKU that was picked.", "format": "int32" }, "shipmentLineStatus": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentLineStatus" }, "basePrice": { "type": "number", "description": "The base price of the SKU.", "format": "double", "example": 50 }, "totalPrice": { "type": "number", "description": "The total price.", "format": "double" } }, "description": "The shipment lines for this shipment.", "xml": { "name": "shipmentLine" } }, "PartnerShipmentService_ShipmentLineStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing shipment line status.", "example": "PENDING_COMPLETION" }, "name": { "type": "string", "description": "The name representing shipment line status.", "example": "Pending Completion" }, "description": { "type": "string", "description": "The description shipment line status.", "example": "The shipment line has been created and is pending completion." } }, "description": "The status of the shipment line.", "xml": { "name": "shipmentLineStatus" } }, "PartnerShipmentService_GetInventoryShipmentLinesResponse": { "required": [ "filteredListCount", "shipmentHeaderId", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderId": { "type": "string", "description": "The unique code representing an existing package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "filteredListCount": { "type": "integer", "description": "The shipment header filtered list count", "format": "int32" }, "totalListCount": { "type": "integer", "description": "Total shipment header list count", "format": "int32" }, "shipmentLines": { "type": "array", "description": "List of shipment headers", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentLine" } } }, "xml": { "name": "getInventoryShipmentLinesResponse" } }, "PartnerShipmentService_CreateUpdateInformation": { "type": "object", "properties": { "dateTime": { "type": "string", "description": "The date and time.", "format": "date-time" }, "userName": { "type": "string", "description": "User name", "example": "hollly.golightly@jtv.com" }, "firstName": { "type": "string", "description": "User First Name", "example": "Holly" }, "lastName": { "type": "string", "description": "User Last Name", "example": "Golightly" } }, "description": "The update information.", "xml": { "name": "createUpdateInformation" } }, "PartnerShipmentService_GetInventoryShipmentHeaderDetailResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeader": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentHeaderDetail" } }, "xml": { "name": "getInventoryShipmentHeaderDetailResponse" } }, "PartnerShipmentService_ShipmentHeaderDetail": { "required": [ "createInformation", "order", "shipmentHeaderId", "shipmentNumber", "shipmentStatus", "shipmentStatusClassification", "shipmentSummary" ], "type": "object", "properties": { "shipmentHeaderId": { "type": "string", "description": "The unique code representing an existing shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentNumber": { "type": "string", "description": "The number of the shipment." }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatus" }, "shipmentStatusClassification": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatusClassification" }, "shipmentCreatedDate": { "type": "string", "description": "The creation date of this shipment.", "format": "date-time" }, "shipmentEstimatedDeliveryDate": { "type": "string", "description": "The expected delivery date of this shipment.", "format": "date-time" }, "order": { "$ref": "#/components/schemas/PartnerOrderService_OrderHeader" }, "shipmentSummary": { "$ref": "#/components/schemas/PartnerShipmentService_InventoryShipmentSummary" }, "createInformation": { "$ref": "#/components/schemas/PartnerShipmentService_CreateUpdateInformation" }, "updateInformation": { "$ref": "#/components/schemas/PartnerShipmentService_CreateUpdateInformation" }, "shipmentLines": { "type": "array", "description": "The shipment lines for this shipment.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentLine" } } }, "description": "The shipment header.", "xml": { "name": "ShipmentHeaderDetail" } }, "PartnerShipmentService_DeleteInventoryShipmentLineResponse": { "required": [ "shipmentLineId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentLineId": { "type": "string", "description": "The unique code representing the shipment line deleted.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "deleteInventoryShipmentLineResponse" } }, "PartnerShipmentService_UpdateInventoryShipmentLineStatus": { "required": [ "code", "shipmentLineId" ], "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "The unique identifiers of shipment line" }, "code": { "type": "integer", "description": "The HTTP status code.", "format": "int32", "example": 200 }, "name": { "type": "string", "description": "The HTTP status code name or business exception error code" }, "description": { "type": "string", "description": "The description." } }, "description": "The shipment lines being updated", "xml": { "name": "updateInventoryShipmentLineStatus" } }, "PartnerShipmentService_UpdateInventoryShipmentLinesResponse": { "required": [ "shipmentHeaderId", "shipmentLines" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderId": { "type": "string", "description": "The unique identifiers of shipment header" }, "shipmentLines": { "type": "array", "description": "The shipment lines being updated", "items": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentLineStatus" } } }, "xml": { "name": "updateInventoryShipmentLinesResponse" } }, "PartnerShipmentService_InventoryShipmentLineQuantity": { "required": [ "quantity", "shipmentLineId" ], "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "The unique identifiers of shipment line" }, "quantity": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "Shipment line quantity", "format": "int32" } }, "description": "The quantity of inventory shipment lines to be updated", "xml": { "name": "inventoryShipmentLineQuantity" } }, "PartnerShipmentService_UpdateInventoryShipmentLinesRequest": { "required": [ "shipmentLines" ], "type": "object", "properties": { "shipmentLines": { "type": "array", "description": "The quantity of inventory shipment lines to be updated", "items": { "$ref": "#/components/schemas/PartnerShipmentService_InventoryShipmentLineQuantity" } } }, "xml": { "name": "updateInventoryShipmentLinesRequest" } }, "PartnerShipmentService_CreateInventoryShipmentPackageHeaderResponse": { "required": [ "packageHeaderId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageHeaderId": { "type": "string", "description": "The unique code representing the package header created.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createInventoryShipmentPackageHeaderResponse" } }, "PartnerShipmentService_CreateInventoryShipmentPackageLineStatus": { "required": [ "code", "packageLineId", "shipmentLineId" ], "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The unique identifiers of package line" }, "shipmentLineId": { "type": "string", "description": "The unique identifiers of shipment line" }, "code": { "type": "integer", "description": "The HTTP status code.", "format": "int32", "example": 201 }, "name": { "type": "string", "description": "The HTTP status code name or business exception error code" }, "description": { "type": "string", "description": "The description." } }, "description": "The package lines created.", "xml": { "name": "createInventoryShipmentPackageLineStatus" } }, "PartnerShipmentService_CreateInventoryShipmentPackageLinesResponse": { "required": [ "packageLineList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLineList": { "type": "array", "description": "The package lines created.", "items": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageLineStatus" } } }, "xml": { "name": "createInventoryShipmentPackageLinesResponse" } }, "PartnerShipmentService_CreateInventoryShipmentPackageLineInfo": { "type": "object", "properties": { "shipmentLineId": { "type": "string", "description": "The unique universal id of the shipment line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "maximum": 999, "minimum": 1, "type": "integer", "description": "The line quantity.", "format": "int32" } }, "description": "Create Inventory Shipment Package Line", "xml": { "name": "createInventoryShipmentPackageLineInfo" } }, "PartnerShipmentService_CreateInventoryShipmentPackageLineRequest": { "required": [ "packageLineList" ], "type": "object", "properties": { "packageLineList": { "type": "array", "description": "Package Line", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_CreateInventoryShipmentPackageLineInfo" } } }, "xml": { "name": "createInventoryShipmentPackageLineRequest" } }, "PartnerShipmentService_UpdateInventoryShipmentPackageLineStatus": { "required": [ "code", "packageLineId" ], "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The unique identifiers of package line" }, "code": { "type": "integer", "description": "The HTTP status code.", "format": "int32", "example": 201 }, "name": { "type": "string", "description": "The HTTP status code name or business exception error code" }, "description": { "type": "string", "description": "The description." } }, "description": "The package lines to be updated", "xml": { "name": "updateInventoryShipmentPackageLineStatus" } }, "PartnerShipmentService_UpdateInventoryShipmentPackageLinesResponse": { "required": [ "packageLineList" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLineList": { "type": "array", "description": "The package lines to be updated", "items": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLineStatus" } } }, "xml": { "name": "updateInventoryShipmentPackageLinesResponse" } }, "PartnerShipmentService_UpdateInventoryShipmentPackageLineInfo": { "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The unique universal id of the package line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "maximum": 999, "minimum": 1, "type": "integer", "description": "The line quantity.", "format": "int32" } }, "description": "Update Inventory Shipment Package Line", "xml": { "name": "updateInventoryShipmentPackageLineInfo" } }, "PartnerShipmentService_UpdateInventoryShipmentPackageLineRequest": { "required": [ "packageLineList" ], "type": "object", "properties": { "packageLineList": { "type": "array", "description": "Package Line", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_UpdateInventoryShipmentPackageLineInfo" } } }, "xml": { "name": "updateInventoryShipmentPackageLineRequest" } }, "PartnerShipmentService_DeleteInventoryShipmentPackageLineInfo": { "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The unique universal id of the package line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "Delete Inventory Shipment Package Line", "xml": { "name": "deleteInventoryShipmentPackageLineInfo" } }, "PartnerShipmentService_DeleteInventoryShipmentPackageLineRequest": { "required": [ "packageLineList" ], "type": "object", "properties": { "packageLineList": { "type": "array", "description": "Package Line", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentPackageLineInfo" } } }, "xml": { "name": "deleteInventoryShipmentPackageLineRequest" } }, "PartnerShipmentService_DeleteInventoryShipmentHeaderStatus": { "required": [ "code", "packageHeaderId" ], "type": "object", "properties": { "packageHeaderId": { "type": "string", "description": "The unique identifiers of package header" }, "code": { "type": "integer", "description": "The HTTP status code.", "format": "int32", "example": 200 }, "name": { "type": "string", "description": "The HTTP status code name or business exception error code" }, "description": { "type": "string", "description": "The description." } }, "description": "The package headers being deleted", "xml": { "name": "deleteInventoryShipmentHeaderStatus" } }, "PartnerShipmentService_DeleteInventoryShipmentPackageHeadersResponse": { "required": [ "packageHeaders" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageHeaders": { "type": "array", "description": "The package headers being deleted", "items": { "$ref": "#/components/schemas/PartnerShipmentService_DeleteInventoryShipmentHeaderStatus" } } }, "xml": { "name": "deleteInventoryShipmentPackageHeadersResponse" } }, "PartnerShipmentService_DeleteInventoryShipmentPackageHeadersRequest": { "required": [ "packageHeaders" ], "type": "object", "properties": { "packageHeaders": { "type": "array", "description": "Identifier of the package headers to be deleted", "items": { "type": "string", "description": "Identifier of the package headers to be deleted", "xml": { "name": "packageHeaders" } } } }, "xml": { "name": "deleteInventoryShipmentPackageHeadersRequest" } }, "PartnerShipmentService_GetInventoryShipmentPackageHeadersResponse": { "required": [ "packageHeaderList", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalListCount": { "type": "integer", "description": "The shipment package list count", "format": "int32" }, "packageHeaderList": { "type": "array", "description": "A list of packages", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_InventoryShipmentPackageHeader" } } }, "xml": { "name": "getInventoryShipmentPackageHeadersResponse" } }, "PartnerShipmentService_InventoryShipmentPackageHeader": { "required": [ "packageId", "packageName", "packageNumber", "packageOrdinal", "packageStatusCode", "packageStatusName" ], "type": "object", "properties": { "packageId": { "type": "string", "description": "The package's unique universal id.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageNumber": { "type": "string", "description": "The package number", "example": "SCPPALWCRU-001" }, "packageOrdinal": { "type": "integer", "description": "The ordinal for list sorting", "format": "int32", "example": 1 }, "packageName": { "type": "string", "description": "The package name", "example": "Package 1" }, "packageStatusCode": { "type": "string", "description": "The package status code", "example": "READY_TO_PACK" }, "packageStatusName": { "type": "string", "description": "The package status name", "example": "Ready to Pack" }, "packingProductTypeCode": { "type": "string", "description": "The packaging product type code" }, "packageSummaryInformation": { "$ref": "#/components/schemas/PartnerShipmentService_InventoryShipmentPackageSummaryInformation" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerShipmentService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerShipmentService_PackageWeight" }, "dateTimeInformation": { "$ref": "#/components/schemas/PartnerShipmentService_PackageDateInformation" } }, "description": "Describes package header", "xml": { "name": "inventoryShipmentPackageHeader" } }, "PartnerShipmentService_InventoryShipmentPackageSummaryInformation": { "type": "object", "properties": { "packageTotalValue": { "type": "number", "description": "The package total dollar value", "format": "double", "example": 95.99 }, "packageTotalOrderLineCount": { "type": "integer", "description": "The package line count", "format": "int32", "example": 2 }, "packageTotalOrderLineQuantity": { "type": "integer", "description": "The package total quantity", "format": "int32", "example": 10 } }, "description": "Describes package summary information", "xml": { "name": "packageSummaryInformation" } }, "PartnerShipmentService_PackageDateInformation": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "The create date for this package.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The expected delivery date of this package.", "format": "date-time" } }, "description": "The packaging datetime information", "xml": { "name": "packageDateInformation" } }, "PartnerShipmentService_PackageDimensions": { "required": [ "packageDimensionsUnitOfMeasureCode", "packageHeight", "packageLength", "packageWidth" ], "type": "object", "properties": { "packageLength": { "type": "number", "description": "The length of the package.", "format": "double", "example": 11 }, "packageWidth": { "type": "number", "description": "The width of the package.", "format": "double", "example": 7 }, "packageHeight": { "type": "number", "description": "The height of the package.", "format": "double", "example": 5 }, "packageDimensionsUnitOfMeasureCode": { "type": "string", "description": "Describes the package dimensions unit of measure", "example": "INCH", "xml": { "name": "packageDimensionsUnitOfMeasureCode" }, "enum": [ "INCH", "CENTIMETER" ] } }, "description": "Describes the package dimensions", "xml": { "name": "packageDimensions" } }, "PartnerShipmentService_PackageWeight": { "required": [ "packageWeight", "packageWeightUnitOfMeasureCode" ], "type": "object", "properties": { "packageWeight": { "type": "number", "description": "The weight of the package.", "format": "double", "example": 13.3 }, "packageWeightUnitOfMeasureCode": { "type": "string", "description": "Describes the package weight's available unit of measure", "example": "POUND", "xml": { "name": "packageWeightUnitOfMeasureCode" }, "enum": [ "POUND", "OUNCE", "KILOGRAM" ] } }, "description": "Describes the package weight", "xml": { "name": "packageWeight" } }, "PartnerShipmentService_UpdateInventoryShipmentPackageHeaderResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageHeaderIds": { "type": "array", "description": "The unique code representing the package header updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique code representing the package header updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "packageHeaderId" } } } }, "xml": { "name": "updateInventoryShipmentPackageHeaderResponse" } }, "PartnerOrderService_UpdateInventoryShipmentPackageHeader": { "required": [ "packageId" ], "type": "object", "properties": { "packageId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing package header to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packagingTypeCode": { "type": "string", "description": "The unique code representing a packaging type code.", "example": "UPS_EXPRESS_BOX_LARGE", "xml": { "name": "packagingTypeCode" }, "enum": [ "UPS_EXPRESS_BOX_SMALL", "UPS_EXPRESS_BOX_MEDIUM", "UPS_EXPRESS_BOX_LARGE", "UPS_25KG_BOX", "UPS_10KG_BOX", "UPS_PAK", "UPS_TUBE", "SMALL_FLAT_RATE_BOX", "MEDIUM_FLAT_RATE_BOX_1_TOP_LOADING", "MEDIUM_FLAT_RATE_BOX_2_SIDE_LOADING", "LARGE_FLAT_RATE_BOX", "APO_FPO_DPO_FLAT_RATE_BOX", "FEDEX_SMALL_BOX", "FEDEX_MEDIUM_BOX", "FEDEX_LARGE_BOX", "FEDEX_EXTRA_LARGE_BOX" ] }, "packageDimensions": { "$ref": "#/components/schemas/PartnerShipmentService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerShipmentService_PackageWeight" } }, "description": "An inventory shipment package header to update", "xml": { "name": "updateInventoryShipmentPackageHeader" } }, "PartnerShipmentService_UpdateInventoryShipmentPackageHeadersRequest": { "required": [ "updateInventoryShipmentPackageHeaders" ], "type": "object", "properties": { "updateInventoryShipmentPackageHeaders": { "type": "array", "description": "The inventory shipment package headers to update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_UpdateInventoryShipmentPackageHeader" } } }, "xml": { "name": "updateInventoryShipmentPackageHeadersRequest" } }, "PartnerShipmentService_GetInventoryShipmentPackageLinesResponse": { "required": [ "packageLineList", "totalListCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "totalListCount": { "type": "integer", "description": "The total package line count", "format": "int32" }, "packageLineList": { "type": "array", "description": "The list of package lines", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_PackageLine" } } }, "xml": { "name": "getInventoryShipmentPackageLinesResponse" } }, "PartnerShipmentService_PackageLine": { "required": [ "packageLineId", "packageLineQuantity", "skuNumber" ], "type": "object", "properties": { "packageLineId": { "type": "string", "description": "The unique code representing an existing package line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "lineNumber": { "type": "integer", "format": "int32" }, "styleImageUrl": { "type": "string", "description": "The image URL of this SKU's style." }, "packageLineQuantity": { "type": "integer", "description": "The quantity of this SKU in the package line.", "format": "int32", "example": 5 }, "skuNumber": { "type": "string", "description": "The SKU product number.", "example": "ABC1234-5" }, "supplierSkuNumber": { "type": "string", "description": "The supplier number for this SKU." }, "styleTitleDescription": { "type": "string", "description": "The title description of this SKU's style." }, "skuSize": { "type": "string", "description": "The SKU size, if applicable.", "example": "6.5" }, "basePrice": { "type": "number", "description": "The current base selling price for the SKU.", "format": "double" }, "totalPrice": { "type": "number", "description": "The total price (basePrice * packageLineQuantity)", "format": "double" } }, "description": "The package line id", "xml": { "name": "packageLine" } }, "PartnerShipmentService_GetInventoryShipmentPackageLineResponse": { "required": [ "packageLine" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLine": { "$ref": "#/components/schemas/PartnerShipmentService_PackageLine" } }, "xml": { "name": "getInventoryShipmentPackageLineResponse" } }, "PartnerShipmentService_GetInventoryRemovalPackageLabelsRequest": { "required": [ "includeOrderInfo", "packageLabelType" ], "type": "object", "properties": { "packageLabelType": { "type": "string", "description": "A code describing the format of the labels to return", "example": "LABEL_FOUR_X_SIX_LABEL", "enum": [ "LETTER_ONE_PER_PAGE", "LETTER_TWO_PER_PAGE", "LABEL_FOUR_X_SIX_LABEL" ] }, "includeOrderInfo": { "type": "boolean", "description": "Include order information on each label?", "example": true }, "packageHeaderUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier of a shipment header from which to find packages to label", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shipmentHeaderUuids": { "maxItems": 50, "minItems": 1, "type": "array", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "shipmentHeaderUuid" } } } }, "xml": { "name": "getInventoryRemovalPackageLabelsRequest" } }, "PartnerPackingSlipService_PartnerInventoryRemovalPackingListRequest": { "required": [ "packageHeaderIdList" ], "type": "object", "properties": { "packageHeaderIdList": { "maxItems": 50, "minItems": 1, "uniqueItems": true, "type": "array", "description": "One or more packager header identifiers to generate a packing list for.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A package header id", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "packageHeaderId" } } } }, "xml": { "name": "partnerInventoryRemovalPackingListRequest" } }, "PartnerShipmentService_GetPackageLinesResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageLineSummary": { "$ref": "#/components/schemas/PartnerShipmentService_PackageLineSummary" } }, "xml": { "name": "getPackageLinesResponse" } }, "PartnerShipmentService_PackageLineDetails": { "required": [ "quantity", "skuNumber", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing an existing package line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "skuNumber": { "type": "string", "description": "The SKU product number.", "example": "ABC1234-5" }, "size": { "type": "string", "description": "The SKU size, if applicable.", "example": "6.5" }, "quantity": { "type": "integer", "description": "The quantity of this SKU in the package.", "format": "int32", "example": 5 }, "styleImageUrl": { "type": "string", "description": "The image URL of this SKU's style." }, "styleTitleDescription": { "type": "string", "description": "The title description of this SKU's style." }, "supplierSkuNumber": { "type": "string", "description": "The supplier number for this SKU." }, "basePrice": { "type": "number", "description": "The current base selling price for the SKU.", "format": "double" }, "currentValue": { "type": "number", "description": "The selling value represented by the product in this package line SKU.", "format": "double" } }, "description": "The package lines for this package", "xml": { "name": "packageLineDetails" } }, "PartnerShipmentService_PackageLineSummary": { "required": [ "filteredSkuCount", "packageMaxValue", "packageUuid", "totalSkuCount" ], "type": "object", "properties": { "packageUuid": { "type": "string", "description": "The unique code representing an existing package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "totalSkuCount": { "type": "integer", "description": "The total number of SKU represented in this package.", "format": "int32", "example": 5 }, "filteredSkuCount": { "type": "integer", "description": "The total number of SKU represented in this package that pass the keyword filter.", "format": "int32", "example": 3 }, "packageMaxValue": { "type": "number", "description": "The maximum sellable value of the package.", "format": "double" }, "packageCurrentValue": { "type": "number", "description": "The total sellable value of the package.", "format": "double" }, "packageLines": { "type": "array", "description": "The package lines for this package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_PackageLineDetails" } } }, "description": "The summary of the package lines within the package, including the list of package lines", "xml": { "name": "packageLineSummary" } }, "PartnerShipmentService_GetShipmentHeadersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentHeaderUuids": { "type": "array", "description": "List of uuids of the shipment headers on the order", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of the shipment headers on the order", "xml": { "name": "shipmentHeaderUuid" } } } }, "xml": { "name": "getShipmentHeadersResponse" } }, "PartnerShipmentService_GetShipmentStatusHistoryResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "statusHistory": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatusHistory" } }, "xml": { "name": "getShipmentStatusHistoryResponse" } }, "PartnerShipmentService_ShipmentStatusHistory": { "required": [ "shipmentId" ], "type": "object", "properties": { "shipmentId": { "type": "string", "description": "The unique code representing an existing shipment header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "currentStatus": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatusHistoryEvent" }, "statusEvents": { "type": "array", "description": "List of shipment status events", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentStatusHistoryEvent" } } }, "description": "Shipment Status History", "xml": { "name": "shipmentStatusHistory" } }, "PartnerShipmentService_ShipmentStatusHistoryEvent": { "required": [ "eventDateTime", "eventStatusCode", "eventStatusDescription", "eventStatusDisplayName" ], "type": "object", "properties": { "eventDateTime": { "type": "string", "description": "Status event date", "format": "date-time", "example": "2020-07-18T12:26:21-04:00" }, "eventStatusCode": { "type": "string", "description": "The unique code representing shipment status.", "example": "SHIPPED" }, "eventStatusDisplayName": { "type": "string", "description": "The name representing the shipment status.", "example": "Shipped" }, "eventStatusDescription": { "type": "string", "description": "The description for the shipment status.", "example": "The shipment has been shipped." } }, "description": "List of shipment status events", "xml": { "name": "shipmentStatusHistoryEvent" } }, "PartnerShipmentService_CreatePackageLinesResponse": { "required": [ "packageUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageUuid": { "type": "string", "description": "The unique code representing an existing package.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageLineUuids": { "type": "array", "description": "List of uuids of created package lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of created package lines", "xml": { "name": "packageLineUuid" } } } }, "xml": { "name": "createPackageLinesResponse" } }, "PartnerShipmentService_CreatePackageLinesRequest": { "required": [ "orderLineQuantities" ], "type": "object", "properties": { "orderLineQuantities": { "type": "array", "description": "The order lines quantities to add to the package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_OrderLineQuantity" } } }, "xml": { "name": "createPackageLinesRequest" } }, "PartnerShipmentService_OrderLineQuantity": { "required": [ "orderLineUuid", "quantity" ], "type": "object", "properties": { "orderLineUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing order line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "type": "integer", "description": "The quantity of the given order line to be assigned to the package.", "format": "int32", "example": 100 } }, "description": "The order lines quantities to add to the package", "xml": { "name": "orderLineQuantity" } }, "PartnerShipmentService_PackageLineQuantity": { "required": [ "packageLineUuid", "quantity" ], "type": "object", "properties": { "packageLineUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing package line.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "quantity": { "type": "integer", "description": "The quantity to assign to the given package line.", "format": "int32", "example": 100 } }, "description": "The package line quantities to be updated", "xml": { "name": "packageLineQuantity" } }, "PartnerShipmentService_UpdatePackageLinesRequest": { "required": [ "packageLineQuantities" ], "type": "object", "properties": { "packageLineQuantities": { "type": "array", "description": "The package line quantities to be updated", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_PackageLineQuantity" } } }, "xml": { "name": "updatePackageLinesRequest" } }, "PartnerShipmentService_DeletePackageLinesResponse": { "required": [ "packageUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageUuid": { "type": "string", "description": "The unique code representing an existing package.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageLineUuids": { "type": "array", "description": "List of uuids of deleted package lines", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of deleted package lines", "xml": { "name": "packageLineUuid" } } } }, "xml": { "name": "deletePackageLinesResponse" } }, "PartnerShipmentService_DeletePackageLinesRequest": { "required": [ "packageLineUuids" ], "type": "object", "properties": { "packageLineUuids": { "type": "array", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the package lines to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "packageLineUuid" } } } }, "xml": { "name": "deletePackageLinesRequest" } }, "PartnerShipmentService_GetShipmentRateOptionsResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentRateOptions": { "type": "array", "description": "shipmentRateOptions", "xml": { "name": "shipmentRateOption" }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentRateOption" } } }, "xml": { "name": "getShipmentRateOptionsResponse" } }, "PartnerShipmentService_ShipmentAccessorial": { "type": "object", "properties": { "code": { "type": "string", "description": "The shipment number of business days in transit.", "example": "todo" }, "description": { "type": "string", "description": "The shipment number of business days in transit.", "example": "todo" } }, "description": "Describes Shipment Accessorial", "xml": { "name": "ShipmentAccessorial" } }, "PartnerShipmentService_ShipmentAlert": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "type": "string", "description": "The shipment alert code.", "example": "code" }, "description": { "type": "string", "description": "The shipment alert description.", "example": "description" } }, "description": "Describes Shipment Alert", "xml": { "name": "ShipmentAlert" } }, "PartnerShipmentService_ShipmentBillingWeight": { "required": [ "unitOfMeasurement", "weight" ], "type": "object", "properties": { "unitOfMeasurement": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentUnitOfMeasure" }, "weight": { "type": "number", "description": "The shipment billing weight.", "format": "float" } }, "description": "Describes Shipment Billing Weight", "xml": { "name": "ShipmentBillingWeight" } }, "PartnerShipmentService_ShipmentCharge": { "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the service.", "example": "Code" }, "description": { "type": "string", "description": "The description of the service.", "example": "description" }, "currencyCode": { "type": "string", "description": "The service currency code.", "example": "USD" }, "monetaryValue": { "type": "number", "description": "The service monetary value." }, "subType": { "type": "string", "description": "The unique code representing the service.", "example": "subType" } }, "description": "Describes a shipment charge", "xml": { "name": "shipmentCharge" } }, "PartnerShipmentService_ShipmentDisclaimer": { "type": "object", "properties": { "code": { "type": "string", "description": "The shipment disclaimer code.", "example": "todo" }, "description": { "type": "string", "description": "The shipment disclaimer description.", "example": "todo" } }, "description": "Describes Shipment Disclaimers", "xml": { "name": "ShipmentDisclaimer" } }, "PartnerShipmentService_ShipmentEstimatedArrival": { "type": "object", "properties": { "arrival": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentPickupType" }, "businessDaysInTransit": { "type": "string", "description": "The shipment number of business days in transit." }, "pickup": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentPickupType" }, "dayOfWeek": { "type": "string", "description": "The shipment estimated arrival day of week." }, "customerCenterCutoff": { "type": "string", "description": "The shipment customer center cutoff." }, "delayCount": { "type": "string", "description": "The shipment delay count." }, "holidayCount": { "type": "string", "description": "The shipment holiday count." }, "restDays": { "type": "string", "description": "The shipment rest days." }, "totalTransitDays": { "type": "string", "description": "The shipment total days in transit." } }, "description": "Describes Shipment Estimated Arrival", "xml": { "name": "ShipmentEstimatedArrival" } }, "PartnerShipmentService_ShipmentGuaranteedDelivery": { "type": "object", "properties": { "businessDaysInTransit": { "type": "string", "description": "The shipment number of business days in transit.", "example": "5" }, "deliveryByTime": { "type": "string", "description": "The shipment delivery by time.", "example": "todo" } }, "description": "Describes Shipment Guaranteed Delivery Parameters", "xml": { "name": "ShipmentGuaranteedDelivery" } }, "PartnerShipmentService_ShipmentPackage": { "type": "object", "properties": { "transportationCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "baseServiceCharge": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "serviceOptionsCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "totalCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "weight": { "type": "string", "description": "The shipment package... " }, "billingWeight": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentBillingWeight" }, "accessorial": { "type": "array", "description": "The shipment package... ", "xml": { "name": "accessorials", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentAccessorial" } }, "itemizedCharges": { "type": "array", "description": "The shipment package... ", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" } }, "negotiatedCharges": { "type": "array", "description": "The shipment package... ", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" } } }, "description": "Describes Shipment Package", "xml": { "name": "ShipmentPackage" } }, "PartnerShipmentService_ShipmentPickupType": { "type": "object", "properties": { "date": { "type": "string", "description": "The arrival/pickup date.", "example": "2001-07-04T12:08:56.235-07:00" }, "time": { "type": "string", "description": "The arrival/pickup time.", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Describes Shipment Arrival/Pickup Date and Time", "xml": { "name": "ShipmentPickupType" } }, "PartnerShipmentService_ShipmentRateOption": { "required": [ "serviceOptionsCharges", "shipmentBillingWeight", "shipmentService", "totalCharges", "transportationCharges" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentService": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentService" }, "shipmentDisclaimers": { "type": "array", "description": "Provides more information to the shipper regarding the processed shipment", "xml": { "name": "disclaimers", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentDisclaimer" } }, "shipmentAlerts": { "type": "array", "description": "Shipment Alerts", "xml": { "name": "alerts", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentAlert" } }, "shipmentBillingWeight": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentBillingWeight" }, "transportationCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "baseServiceCharge": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "itemizedCharges": { "type": "array", "description": "Itemized Charges", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" } }, "serviceOptionsCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "taxCharges": { "type": "array", "description": "Tax Charges", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentTaxCharge" } }, "totalCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "totalChargesWithTaxes": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "negotiatedRateCharges": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentTotalCharge" }, "guaranteedDelivery": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentGuaranteedDelivery" }, "shipmentPackages": { "type": "array", "description": "Rated Package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentPackage" } }, "shipmentTimeInTransit": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentTimeInTransit" } }, "description": "shipmentRateOptions", "xml": { "name": "shipmentRateOption" } }, "PartnerShipmentService_ShipmentService": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the service.", "example": "Code" }, "description": { "type": "string", "description": "The description for the service.", "example": "Description" } }, "description": "Describes Shipment Service", "xml": { "name": "serviceShipment" } }, "PartnerShipmentService_ShipmentServiceSummary": { "type": "object", "properties": { "service": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentService" }, "estimatedArrival": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentEstimatedArrival" }, "guaranteedIndicator": { "type": "string", "description": "The shipment service guartanteed indicator" }, "disclaimer": { "type": "string", "description": "The shipment disclaimer." }, "saturdayDelivery": { "type": "string", "description": "The shipment Saturday service indicator." }, "saturdayDeliveryDisclaimer": { "type": "string", "description": "The shipment Saturday service disclaimer." } }, "description": "Describes Shipment Service Summary", "xml": { "name": "ShipmentServiceSummary" } }, "PartnerShipmentService_ShipmentTaxCharge": { "required": [ "monetaryValue", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The tax type code represents the type of Tax applied to a shipment.", "example": "todo" }, "monetaryValue": { "type": "number", "description": "The monetary value of the tax charge." } }, "description": "Describes Shipment Tax Charge", "xml": { "name": "ShipmentTaxCharge" } }, "PartnerShipmentService_ShipmentTimeInTransit": { "type": "object", "properties": { "pickupDate": { "type": "string", "description": "The shipment pickup date.", "example": "todo" }, "documentsOnlyIndicator": { "type": "string", "description": "The shipment documents only indicator.", "example": "todo" }, "packageBillType": { "type": "string", "description": "The shipment package bill type.", "example": "todo" }, "autoDutyCode": { "type": "string", "description": "The shipment auto duty code.", "example": "todo" }, "disclaimer": { "type": "string", "description": "The shipment disclaimer code.", "example": "todo" }, "serviceSummary": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentServiceSummary" } }, "description": "Describes Shipment Time In Transit", "xml": { "name": "ShipmentTimeInTransit" } }, "PartnerShipmentService_ShipmentTotalCharge": { "type": "object", "properties": { "itemizedCharges": { "type": "array", "description": "The shipment itemized charges.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" } }, "taxCharges": { "type": "array", "description": "The shipment number of business days in transit.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentTaxCharge" } }, "totalCharge": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" }, "totalChargesWithTaxes": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentCharge" } }, "description": "Describes Shipment Total Charge", "xml": { "name": "ShipmentTotalCharge" } }, "PartnerShipmentService_ShipmentUnitOfMeasure": { "required": [ "code", "description" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the unit of measure.", "example": "INCH" }, "description": { "type": "string", "description": "The description for the unit of measure.", "example": "Inch" } }, "description": "Describes an available metric for measurement", "xml": { "name": "shipmentUnitOfMeasure" } }, "ship-date": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" } }, "description": "The shipment's expected ship date.", "example": "2001-07-04T12:08:56.235-07:00" }, "PartnerShipmentService_UpdatePackageHeaderResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageHeaderUuids": { "type": "array", "description": "List of uuids of updated package headers", "xml": { "wrapped": true }, "items": { "type": "string", "description": "List of uuids of updated package headers", "xml": { "name": "packageHeaderUuid" } } } }, "xml": { "name": "updatePackageHeaderResponse" } }, "PartnerOrderService_UpdatePackageHeader": { "required": [ "packageId" ], "type": "object", "properties": { "packageId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique code representing an existing package header to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packagingTypeCode": { "type": "string", "description": "The unique code representing a packaging type code.", "example": "UPS_EXPRESS_BOX_LARGE", "xml": { "name": "packagingTypeCode" }, "enum": [ "UPS_EXPRESS_BOX_SMALL", "UPS_EXPRESS_BOX_MEDIUM", "UPS_EXPRESS_BOX_LARGE", "UPS_25KG_BOX", "UPS_10KG_BOX", "UPS_PAK", "UPS_TUBE", "SMALL_FLAT_RATE_BOX", "MEDIUM_FLAT_RATE_BOX_1_TOP_LOADING", "MEDIUM_FLAT_RATE_BOX_2_SIDE_LOADING", "LARGE_FLAT_RATE_BOX", "APO_FPO_DPO_FLAT_RATE_BOX", "FEDEX_SMALL_BOX", "FEDEX_MEDIUM_BOX", "FEDEX_LARGE_BOX", "FEDEX_EXTRA_LARGE_BOX" ] }, "packageDimensions": { "$ref": "#/components/schemas/PartnerShipmentService_PackageDimensions" }, "packageWeight": { "$ref": "#/components/schemas/PartnerShipmentService_PackageWeight" }, "packageTrackingCode": { "type": "string", "description": "The package tracking code (for custom carriers only)." } }, "description": "A package header to update", "xml": { "name": "updatePackageHeader" } }, "PartnerOrderService_UpdatePackageHeadersRequest": { "required": [ "updatePackageHeaders" ], "type": "object", "properties": { "updatePackageHeaders": { "type": "array", "description": "The package headers to update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerOrderService_UpdatePackageHeader" } } }, "xml": { "name": "updatePackageHeadersRequest" } }, "PartnerShipmentService_DeletePackageHeadersRequest": { "required": [ "packageHeaderIds" ], "type": "object", "properties": { "packageHeaderIds": { "type": "array", "description": "The unique identifiers of the package headers to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique identifiers of the package headers to be deleted", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "packageHeaderId" } } } }, "xml": { "name": "deletePackageHeadersRequest" } }, "PartnerShipmentService_Carrier": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the carrier.", "example": "UPS" }, "name": { "type": "string", "description": "The name representing the carrier.", "example": "United Parcel Service (UPS)" }, "description": { "type": "string", "description": "The description for the carrier.", "example": "United Parcel Service" } }, "description": "The carrier details for this shipment.", "xml": { "name": "carrier" } }, "PartnerShipmentService_CarrierService": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the carrier service.", "example": "UPS_STANDARD" }, "name": { "type": "string", "description": "The name representing the carrier service.", "example": "UPS Standard" }, "description": { "type": "string", "description": "The description for the carrier service.", "example": "UPS Standard" } }, "description": "The carrier service details for this shipment.", "xml": { "name": "carrierService" } }, "PartnerShipmentService_GetPackageHeadersResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentSummary": { "$ref": "#/components/schemas/PartnerShipmentService_ShipmentSummary" } }, "xml": { "name": "getPackageHeadersResponse" } }, "PartnerShipmentService_PackageDimensionsResponse": { "required": [ "height", "length", "unitOfMeasure", "width" ], "type": "object", "properties": { "length": { "type": "number", "description": "The package length dimension.", "format": "double", "example": 12 }, "width": { "type": "number", "description": "The package length dimension.", "format": "double", "example": 13 }, "height": { "type": "number", "description": "The package height dimension.", "format": "double", "example": 7 }, "unitOfMeasure": { "$ref": "#/components/schemas/PartnerShipmentService_UnitOfMeasure" } }, "description": "Describes a package's dimensions", "xml": { "name": "packageDimensionsResponse" } }, "PartnerShipmentService_PackageHeader": { "required": [ "billableWeight", "packageMaxValue", "packageName", "packageNumber", "packageOrdinal", "packageStatus", "packageUuid", "skuCount", "totalQuantity", "weightUnitOfMeasure" ], "type": "object", "properties": { "packageUuid": { "type": "string", "description": "The unique code representing an existing package header.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageOrdinal": { "type": "integer", "description": "The ordinal of this package within the shipment.", "format": "int32", "example": 3 }, "packageNumber": { "type": "string", "description": "The number of the package." }, "packageName": { "type": "string", "description": "The name of the package." }, "trackingNumber": { "type": "string", "description": "The tracking number of the package." }, "carrierServiceShipCode": { "type": "string", "description": "The partnered carrier shipping code for this package (or 00 = custom carrier)." }, "carrierServiceRateCode": { "type": "string", "description": "The partnered carrier rate code for this package (or 00 = custom carrier)." }, "packagingType": { "$ref": "#/components/schemas/PartnerShipmentService_PackagingType" }, "packageStatus": { "$ref": "#/components/schemas/PartnerShipmentService_PackageStatus" }, "packageDimensions": { "$ref": "#/components/schemas/PartnerShipmentService_PackageDimensionsResponse" }, "weight": { "type": "number", "description": "The weight of the package.", "format": "double" }, "billableWeight": { "type": "number", "description": "The billable weight of the package.", "format": "double" }, "weightUnitOfMeasure": { "$ref": "#/components/schemas/PartnerShipmentService_UnitOfMeasure" }, "skuCount": { "type": "integer", "description": "The number of SKUs having quantity within the package.", "format": "int32" }, "totalQuantity": { "type": "integer", "description": "The total item quantity of within the package.", "format": "int32" }, "packageMaxValue": { "type": "number", "description": "The maximum sellable value of the package.", "format": "double" }, "packageCurrentValue": { "type": "number", "description": "The total sellable value of the package.", "format": "double" }, "createdDate": { "type": "string", "description": "The create date for this shipment.", "format": "date-time" }, "expectedDeliveryDate": { "type": "string", "description": "The expected delivery date of this shipment.", "format": "date-time" } }, "description": "The package headers for this shipment", "xml": { "name": "packageHeader" } }, "PartnerShipmentService_PackagingType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "Packaging Type code" }, "name": { "type": "string", "description": "Packaging Type name" }, "description": { "type": "string", "description": "Packaging Type description" }, "carrierCode": { "type": "string", "description": "Packaging Type carrier code" } }, "description": "The packaging type of the package.", "xml": { "name": "packagingType" } }, "PartnerShipmentService_ShipmentSummary": { "required": [ "labelVoidEligible", "numberOfPackages", "shipmentNumber", "totalBillableWeight", "totalCharges", "totalWeight" ], "type": "object", "properties": { "shipmentNumber": { "type": "string", "description": "The shipment's unique number.", "example": "PS2CG813721C" }, "totalWeight": { "type": "number", "description": "The total weight of all packages in the shipment.", "format": "double", "example": 150.0 }, "totalBillableWeight": { "type": "number", "description": "The total billable weight of all packages in the shipment.", "format": "double", "example": 150.0 }, "totalWeightUnitOfMeasure": { "$ref": "#/components/schemas/PartnerShipmentService_UnitOfMeasure" }, "totalCharges": { "type": "number", "description": "The total charges of all packages in the shipment.", "format": "double", "example": 150.0 }, "expectedShipDate": { "type": "string", "description": "The expected ship date of this shipment.", "format": "date-time" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated delivery date of this shipment.", "format": "date-time" }, "shippedDate": { "type": "string", "description": "The date the shipment was shipped.", "format": "date-time" }, "labelVoidEligible": { "type": "boolean", "description": "A flag indicating whether or not the shipping labels can be voided.", "example": true }, "numberOfPackages": { "type": "integer", "description": "The total number of packages in this shipment", "format": "int32", "example": 3 }, "labelVoidDate": { "type": "string", "description": "The maximum label void window for this shipment.", "format": "date-time" }, "carrierService": { "$ref": "#/components/schemas/PartnerShipmentService_CarrierService" }, "carrier": { "$ref": "#/components/schemas/PartnerShipmentService_Carrier" }, "packageHeaders": { "type": "array", "description": "The package headers for this shipment", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_PackageHeader" } } }, "description": "The summary of the packages within the shipment, including the list of package headers", "xml": { "name": "shipmentSummary" } }, "PartnerShipmentService_UnitOfMeasure": { "required": [ "abbreviation", "baseQuantityCode", "baseQuantityName", "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the unit of measure.", "example": "INCH" }, "name": { "type": "string", "description": "The name representing the unit of measure.", "example": "inch" }, "description": { "type": "string", "description": "The description for the unit of measure.", "example": "Inch" }, "abbreviation": { "type": "string", "description": "The abbreviation representing the unit of measure.", "example": "in" }, "baseQuantityCode": { "type": "string", "description": "The base quantity code for the unit of measure.", "example": "LENGTH" }, "baseQuantityName": { "type": "string", "description": "The base quantity name for the unit of measure.", "example": "Length" } }, "description": "Describes an available metric for measurement", "xml": { "name": "unitOfMeasure" } }, "PartnerShipmentService_GetTrackingEventsResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "packageTrackingEventSummary": { "$ref": "#/components/schemas/PartnerShipmentService_PackageTrackingEventSummary" } }, "xml": { "name": "getTrackingEventsResponse" } }, "PartnerShipmentService_PackageDeliveryDates": { "type": "object", "properties": { "eddBeginDate": { "type": "string", "description": "The package's estimated delivers begin date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "eddEndDate": { "type": "string", "description": "The package's estimated delivers end date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "deliveryDate": { "type": "string", "description": "The package's estimated delivers date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "The package delivery dates.", "xml": { "name": "packageDeliveryDates" } }, "PartnerShipmentService_PackageTrackingBaseLocation": { "type": "object", "properties": { "city": { "type": "string", "description": "Address city", "example": "Knoxville" }, "state": { "type": "string", "description": "Address State or Province Abbreviation", "example": "TN" }, "zip": { "type": "string", "description": "Address postal code number or delivery zone number.", "example": "37922-6748" }, "country": { "type": "string", "description": "Address Country Abbreviation", "example": "USA" } }, "description": "Package tracking location", "xml": { "name": "packageTrackingBaseLocation" } }, "PartnerShipmentService_PackageTrackingEvent": { "type": "object", "properties": { "eventDate": { "type": "string", "description": "The event date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "eventStatusCode": { "type": "string", "description": "The event status code.", "example": "DELIVERED_GENERAL" }, "eventStatusDisplayName": { "type": "string", "description": "The event status display name.", "example": "Delivered: General" }, "eventStatusDescription": { "type": "string", "description": "The event status description.", "example": "Delivered: General" }, "eventStatusDisplayOrder": { "type": "integer", "description": "The event status display order.", "format": "int32", "example": 1 }, "location": { "$ref": "#/components/schemas/PartnerShipmentService_PackageTrackingBaseLocation" } }, "description": "Package tracking", "xml": { "name": "packageTrackingEvent" } }, "PartnerShipmentService_PackageTrackingEventSummary": { "type": "object", "properties": { "packageNumber": { "type": "string", "description": "The package number.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "packageOrdinal": { "type": "integer", "description": "The package's order in shipment.", "format": "int32", "example": 1 }, "carrier": { "$ref": "#/components/schemas/PartnerShipmentService_PartnerTrackingCarrier" }, "currentStatus": { "$ref": "#/components/schemas/PartnerShipmentService_PackageTrackingStatus" }, "delivery": { "$ref": "#/components/schemas/PartnerShipmentService_PackageDeliveryDates" }, "events": { "type": "array", "description": "The package tracking events for this package", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShipmentService_PackageTrackingEvent" } } }, "description": "The summary of the package tracking events the package, including the list of package tracking events", "xml": { "name": "packageTrackingEventSummary" } }, "PartnerShipmentService_PackageTrackingStatus": { "required": [ "statusCode", "statusDate", "statusDescription", "statusDisplayName", "statusDisplayOrder" ], "type": "object", "properties": { "statusCode": { "type": "string", "description": "The unique code representing package status.", "example": "DELIVERED" }, "statusDisplayName": { "type": "string", "description": "The display name for status.", "example": "Delivered" }, "statusDescription": { "type": "string", "description": "The description for the package status.", "example": "Delivered" }, "statusDisplayOrder": { "type": "integer", "description": "The status display order.", "format": "int32", "example": 1 }, "statusDate": { "type": "string", "description": "The date for the package status.", "format": "date-time" } }, "description": "The current status of the package.", "xml": { "name": "packageTrackingStatus" } }, "PartnerShipmentService_PartnerTrackingCarrier": { "type": "object", "properties": { "carrierCode": { "type": "string", "description": "The code representing a carrier.", "example": "UPS" }, "carrierDisplayName": { "type": "string", "description": "The carrier display name.", "example": "United Parcel Service (UPS)" }, "carrierDescription": { "type": "string", "description": "The carrier description.", "example": "United Parcel Service" }, "serviceCode": { "type": "string", "description": "The service code.", "example": "UPS_GROUND" }, "serviceDisplayName": { "type": "string", "description": "The carrier service display name.", "example": "UPS Ground" }, "serviceDescription": { "type": "string", "description": "The carrier service description.", "example": "UPS Ground" }, "partnerCarrierCode": { "type": "string", "description": "The partner carrier code.", "example": "UPS" }, "partnerCarrierDisplayName": { "type": "string", "description": "The partner carrier display name.", "example": "United Parcel Service (UPS)" }, "partnerCarrierDescription": { "type": "string", "description": "The partner carrier description.", "example": "United Parcel Service" }, "partnerTrackingNumber": { "type": "string", "description": "The partner tracking number.", "example": "partnerTrackingNumber" } }, "description": "The package carrier.", "xml": { "name": "partnerTrackingCarrier" } }, "PartnerShipmentLabelService_PartnerShipmentLabelsResponse": { "required": [ "pdfBytes" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "pdfBytes": { "type": "array", "description": "Partner shipment labels PDF for a shipment id", "xml": { "name": "partnerShipmentLabelsPDF" }, "items": { "type": "string", "description": "Partner shipment labels PDF for a shipment id", "format": "byte", "xml": { "name": "partnerShipmentLabelsPDF" } } } }, "xml": { "name": "partnerShipmentLabelsResponse" } }, "PartnerShipmentLabelService_ShipmentStatus": { "type": "object", "properties": { "code": { "type": "string", "description": "Partner shipment status code" }, "name": { "type": "string", "description": "Partner shipment status name" }, "description": { "type": "string", "description": "Partner shipment status description", "xml": { "name": "descripiton" } } }, "description": "Partner shipment status after the void operation", "xml": { "name": "shipmentStatus" } }, "PartnerShipmentLabelService_VoidShipmentResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shipmentStatus": { "$ref": "#/components/schemas/PartnerShipmentLabelService_ShipmentStatus" }, "shipmentId": { "type": "string", "description": "Partner shipment id" } }, "xml": { "name": "voidShipmentResponse" } }, "PartnerProfileService_GetPartnerShopProfileResponse": { "required": [ "partnerShopProfile" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfile": { "type": "array", "description": "The partner shop profile.", "xml": { "name": "partnerShopProfiles", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfile" } } }, "xml": { "name": "getPartnerShopProfileResponse" } }, "PartnerShopProfileService_PartnerSellerProfile": { "required": [ "sellerProfileId" ], "type": "object", "properties": { "sellerProfileId": { "type": "string", "description": "The unique code representing the partner's linked seller profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "sellerProfileDisplayFirstName": { "type": "string", "description": "Display first name of the user profile.", "example": "Jimmy" }, "sellerProfileDisplayLastName": { "type": "string", "description": "Display last name of the user profile.", "example": "Lars" } }, "description": "Describes the linked user profile of type Seller", "xml": { "name": "partnerSellerProfile" } }, "PartnerShopProfileService_PartnerShopProfile": { "required": [ "partnerShopProfileCategory", "partnerShopProfileDescription", "partnerShopProfileGeography", "partnerShopProfileLabel", "partnerShopProfileStatus", "profileId", "profileNumber" ], "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique code representing an existing profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The unique string representing an existing profile.", "example": "SDBWZ7KW" }, "profileDisplayName": { "type": "string", "description": "The display name representing the profile.", "example": "Profile display name" }, "profileLogoImageUrl": { "type": "string", "description": "The delivery URL of the profile logo image." }, "partnerSellerProfile": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerSellerProfile" }, "partnerShopProfileStatus": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileStatus" }, "partnerShopProfileGeography": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileGeography" }, "partnerShopProfileDescription": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileDescription" }, "partnerShopProfileCategory": { "type": "array", "description": "The profile Categories.", "xml": { "name": "partnerShopProfileCategories", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileCategory" } }, "partnerShopProfileLabel": { "type": "array", "description": "The profile Labels.", "xml": { "name": "partnerShopProfileLabels", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileLabel" } } }, "description": "Describes the partner shop profile", "xml": { "name": "partnerShopProfile" } }, "PartnerShopProfileService_PartnerShopProfileCategory": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the category.", "example": "FAST_FASHION" }, "name": { "type": "string", "description": "The name representing the category.", "example": "Fast-Fashion" }, "description": { "type": "string", "description": "The description for the category.", "example": "Fast-Fashion" } }, "description": "Describes the profile category", "xml": { "name": "partnerShopProfileCategory" } }, "PartnerShopProfileService_PartnerShopProfileDescription": { "type": "object", "properties": { "titleDescription": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The profile title description. Max 100 characters", "example": "My Online Jewelry Shop" }, "announcement": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The announcement for the profile. Max 4000 characters", "example": "We are open Labor Day" } }, "description": "Describes profile properties with descriptions", "xml": { "name": "partnerShopProfileDescription" } }, "PartnerShopProfileService_PartnerShopProfileGeography": { "type": "object", "properties": { "cityName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The city name. Max 100 characters", "example": "Nashville" }, "countryName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The country name. Max 100 characters", "example": "United States" }, "stateProvinceName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The State Province name. Max 100 characters", "example": "Tennessee" } }, "description": "Describes the profile geography", "xml": { "name": "partnerShopProfileGeography" } }, "PartnerShopProfileService_PartnerShopProfileLabel": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the label.", "example": "POPULAR_TODAY" }, "name": { "type": "string", "description": "The name representing the label.", "example": "Popular Today" }, "description": { "type": "string", "description": "The description for the label.", "example": "Popular Today" } }, "description": "Describes the profile label", "xml": { "name": "partnerShopProfileLabel" } }, "PartnerShopProfileService_PartnerShopProfileStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the profile status.", "example": "ACTIVE" }, "name": { "type": "string", "description": "The name representing the profile status.", "example": "Active" }, "description": { "type": "string", "description": "The description for the profile status.", "example": "The profile has been activated, and therefore may be displayed on the Storefront." } }, "description": "Describes the profile status", "xml": { "name": "partnerShopProfileStatus" } }, "PartnerProfileService_GetPartnerShopProfilesResponse": { "required": [ "partnerShopProfileListSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileListSummary": { "type": "array", "description": "The partner shop profile list summary.", "xml": { "name": "partnerShopProfileListSummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileListSummary" } } }, "xml": { "name": "getPartnerShopProfilesResponse" } }, "PartnerShopProfileService_Media": { "required": [ "mediaId", "mediaStatus", "mediaType", "mediaUrl" ], "type": "object", "properties": { "mediaId": { "type": "string", "description": "The unique code representing the media.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "mediaUrl": { "type": "string", "description": "The media URL.", "example": "flamingo.hk" }, "mediaStatus": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaStatus" }, "mediaType": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaType" } }, "description": "Describes the profile media.", "example": "PDF", "xml": { "name": "media" } }, "PartnerShopProfileService_MediaStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "APPROVED" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Approved" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Approved Status" } }, "description": "Describes the media status", "xml": { "name": "mediaStatus" } }, "PartnerShopProfileService_MediaType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media type.", "example": "PDF" }, "name": { "type": "string", "description": "The name representing the media type.", "example": "PDF" }, "description": { "type": "string", "description": "The description for the media type.", "example": "PDF File" } }, "description": "Describes the media type", "xml": { "name": "mediaType" } }, "PartnerShopProfileService_PartnerShopProfileListSummary": { "required": [ "partnerShopProfileStatus", "profileDisplayName", "profileNumber", "profileUuid" ], "type": "object", "properties": { "profileUuid": { "type": "string", "description": "The unique code representing an existing summary profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The unique string representing an existing summary profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "partnerSellerProfile": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerSellerProfile" }, "partnerShopProfileStatus": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileStatus" }, "profileDisplayName": { "type": "string", "description": "The display name representing the profile.", "example": "Profile display name" }, "media": { "$ref": "#/components/schemas/PartnerShopProfileService_Media" } }, "description": "Describes the profile summary when retrieving a list of profiles", "xml": { "name": "partnerShopProfileSummary" } }, "PartnerProfileService_CreatePartnerShopProfileAboutItemsResponse": { "required": [ "partnerShopProfileAboutItemSummaries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileAboutItemSummaries": { "type": "array", "description": "The partner shop about item summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileAboutItemSummary" } } }, "xml": { "name": "createPartnerShopProfileAboutItemsResponse" } }, "PartnerShopProfileService_PartnerShopProfileAboutItemSummary": { "required": [ "partnerShopProfileAboutItemUuid", "positionOrdinal" ], "type": "object", "properties": { "partnerShopProfileAboutItemUuid": { "type": "string", "description": "The unique code representing an about item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal representing where this about item should be rendered in relation to other about items.", "format": "int64", "example": 1 } }, "description": "Gives topical information to reference an about item.", "xml": { "name": "PartnerShopProfileAboutItemSummary" } }, "PartnerShopProfileService_CreatePartnerShopProfileAboutItemsRequest": { "required": [ "partnerShopProfileAboutItems" ], "type": "object", "properties": { "partnerShopProfileAboutItems": { "maxItems": 8, "minItems": 0, "type": "array", "description": "About items containing a headline, description, and position ordinal for the partner's shop profile. Max items = 8", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileAboutItem" } } }, "xml": { "name": "createPartnerShopProfileAboutItemsRequest" } }, "PartnerShopProfileService_PartnerShopProfileAboutItem": { "required": [ "description", "headline", "positionOrdinal" ], "type": "object", "properties": { "headline": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The headline for the about item, which must be between 1-200 characters.", "example": "Our Story as a Shop" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The description for the about item, which must be between 1-4000 characters.", "example": "Born as a dairy farmers, my sister and I discovered radioactive gemstones on our farm. We used those gemstones to give ourselves magical abilities capable of selling jewelry on awesome ecommerce marketplaces." }, "positionOrdinal": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "The position ordinal of where this about item should be displayed in relation to other about items. Must be an integer greater than zero and sequential with all other about items.", "format": "int64", "example": 10 } }, "description": "Describes the partner's shop profile About Item which contains a headline, description, and position ordinal.", "xml": { "name": "partnerShopProfileDescription" } }, "PartnerProfileService_CreatePartnerShopProfileResponse": { "required": [ "partnerShopProfileSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileSummary": { "type": "array", "description": "The partner shop summary profiles.", "xml": { "name": "partnerShopProfileSummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileSummary" } } }, "xml": { "name": "createPartnerShopProfileResponse" } }, "PartnerShopProfileService_PartnerShopProfileSummary": { "required": [ "partnerShopProfileStatus", "profileNumber", "profileUuid" ], "type": "object", "properties": { "profileUuid": { "type": "string", "description": "The unique code representing an existing summary profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The unique profile number representing an existing profile.", "example": "SDBWZ7KW" }, "partnerShopProfileStatus": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileStatus" } }, "description": "Describes the profile summary", "xml": { "name": "partnerShopProfileSummary" } }, "PartnerShopProfileService_CreatePartnerShopProfile": { "required": [ "profileDisplayName" ], "type": "object", "properties": { "profileDisplayName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The profile display name. Max = 100 characters. Valid Characters are: a-z A-Z 0-9 : & , ' ( ) - + ! . space" }, "sellerProfileId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "A reference to a user profile UUID with type SELLER.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "partnerShopProfileGeography": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileGeography" }, "partnerShopProfileDescription": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileDescription" }, "partnerShopProfileCategories": { "type": "array", "description": "The profile category code list. Max 8 categories. Max Category Length 50 characters.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The profile category code list. Max 8 categories. Max Category Length 50 characters.", "xml": { "name": "partnerShopProfileCategory" } } }, "partnerShopProfileLabels": { "type": "array", "description": "The profile label code list. Max 3 labels. Max Label Length 50 characters.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The profile label code list. Max 3 labels. Max Label Length 50 characters.", "xml": { "name": "partnerShopProfileLabel" } } } }, "description": "Describes the partner shop profile", "xml": { "name": "createPartnerShopProfile" } }, "PartnerShopProfileService_CreatePartnerShopProfileRequest": { "required": [ "createPartnerShopProfile" ], "type": "object", "properties": { "createPartnerShopProfile": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfile" } }, "xml": { "name": "createPartnerShopProfileRequest" } }, "PartnerProfileService_CreatePartnerShopProfileExternalLinksResponse": { "required": [ "externalLinkSummaries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "externalLinkSummaries": { "type": "array", "description": "The partner shop external link summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileExternalLinkSummary" } } }, "xml": { "name": "createPartnerShopProfileExternalLinksResponse" } }, "PartnerShopProfileService_PartnerShopProfileExternalLinkSummary": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing an external link.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "Gives topical information to reference an external link.", "xml": { "name": "PartnerShopProfileExternalLinkSummary" } }, "PartnerShopProfileService_CreatePartnerShopProfileExternalLinksRequest": { "type": "object", "properties": { "externalLinks": { "type": "array", "description": "A list of external links containing a type code and handle for the partner's shop profile. May be empty if you wish to remove all existing external links.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileExternalLink" } } }, "xml": { "name": "createPartnerShopProfileExternalLinksRequest" } }, "PartnerShopProfileService_PartnerShopProfileExternalLink": { "required": [ "handle", "typeCode" ], "type": "object", "properties": { "handle": { "maxLength": 2000, "minLength": 1, "type": "string", "description": "The handle (for social media links) or full URL (for custom links) of the external link.", "example": "@bestRingShop" }, "typeCode": { "pattern": "^FACEBOOK|YOUTUBE|INSTAGRAM|PINTEREST|TWITTER|CUSTOM_WEBSITE$", "type": "string", "description": "The type code of the external link", "example": "FACEBOOK", "enum": [ "FACEBOOK", "YOUTUBE", "INSTAGRAM", "PINTEREST", "TWITTER", "CUSTOM_WEBSITE" ] } }, "description": "Describes the partner's shop profile External Link.", "xml": { "name": "partnerShopProfileExternalLink" } }, "PartnerProfileService_GetPartnerShopProfileAboutItemsResponse": { "required": [ "partnerShopProfileAboutItemDetails" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileAboutItemDetails": { "type": "array", "description": "The partner shop about item details.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileAboutItemDetail" } } }, "xml": { "name": "getPartnerShopProfileAboutItemsResponse" } }, "PartnerShopProfileService_PartnerShopProfileAboutItemDetail": { "required": [ "description", "headline", "partnerShopProfileAboutItemId", "positionOrdinal" ], "type": "object", "properties": { "partnerShopProfileAboutItemId": { "type": "string", "description": "The unique code representing an about item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "headline": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The headline for the about item, which must be between 1-200 characters.", "example": "Our Story as a Shop" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The description for the about item, which must be between 1-4000 characters.", "example": "Born as a dairy farmers, my sister and I discovered radioactive gemstones on our farm. We used those gemstones to give ourselves magical abilities capable of selling jewelry on awesome ecommerce marketplaces." }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of where this about item should be displayed in relation to other about items. Must be an integer greater than zero and consecutive with all other about items.", "format": "int32", "example": 1 } }, "description": "Describes the partner shop profile about item.", "xml": { "name": "partnerShopProfileAboutItemDetail" } }, "PartnerProfileService_CreatePartnerShopProfileFeaturedListingsResponse": { "required": [ "createPartnerShopProfileFeaturedListingSummaries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "createPartnerShopProfileFeaturedListingSummaries": { "type": "array", "description": "The partner shop profile featured listing summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFeaturedListingSummary" } } }, "xml": { "name": "createPartnerShopProfileFeaturedListingsResponse" } }, "PartnerShopProfileService_CreatePartnerShopProfileFeaturedListingSummary": { "required": [ "partnerShopProfileFeaturedListingUuid", "positionOrdinal" ], "type": "object", "properties": { "partnerShopProfileFeaturedListingUuid": { "type": "string", "description": "The unique code representing a featured listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal representing where this featured listing should be rendered in relation to other featured listings.", "format": "int64", "example": 1 } }, "description": "Gives topical information to reference a featured listing.", "xml": { "name": "CreatePartnerShopProfileFeaturedListingSummary" } }, "PartnerShopProfileService_CreatePartnerShopProfileFeaturedListing": { "required": [ "positionOrdinal", "styleNumber" ], "type": "object", "properties": { "styleNumber": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The style number for the featured listing request.", "example": "DQK998" }, "positionOrdinal": { "maximum": 8, "minimum": 1, "type": "integer", "description": "The position ordinal of where this featured listing should be displayed in relation to other featured listings. Must be an integer greater than zero and sequential with all other featured listings.", "format": "int64", "example": 4 } }, "description": "Describes a request item to create a partner shop profile featured listing.", "xml": { "name": "createPartnerShopProfileFeaturedListing" } }, "PartnerShopProfileService_CreatePartnerShopProfileFeaturedListingsRequest": { "required": [ "shopProfileFeaturedListings" ], "type": "object", "properties": { "shopProfileFeaturedListings": { "maxItems": 8, "minItems": 1, "type": "array", "description": "A list of featured listings to be created including a style number and a position ordinal. Max items = 8", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_CreatePartnerShopProfileFeaturedListing" } } }, "xml": { "name": "CreatePartnerShopProfileFeaturedListingsRequest" } }, "PartnerProfileService_UpdatePartnerShopProfileFeaturedListingsResponse": { "required": [ "updatePartnerShopProfileFeaturedListingSummaries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "updatePartnerShopProfileFeaturedListingSummaries": { "type": "array", "description": "The partner shop profile featured listing summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListingSummary" } } }, "xml": { "name": "updatePartnerShopProfileFeaturedListingsResponse" } }, "PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListingSummary": { "required": [ "partnerShopProfileFeaturedListingUuid", "positionOrdinal" ], "type": "object", "properties": { "partnerShopProfileFeaturedListingUuid": { "type": "string", "description": "The unique code representing a featured listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal representing where this featured listing should be rendered in relation to other featured listings.", "format": "int64", "example": 1 } }, "description": "Gives topical information to reference a featured listing.", "xml": { "name": "UpdatePartnerShopProfileFeaturedListingSummary" } }, "PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListing": { "required": [ "featuredListingId", "positionOrdinal" ], "type": "object", "properties": { "featuredListingId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The featured listing's unique universal identifier.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "maximum": 8, "minimum": 1, "type": "integer", "description": "The position ordinal of where this featured listing should be displayed in relation to other featured listings. Must be an integer greater than zero and sequential with all other featured listings.", "format": "int64", "example": 4 } }, "description": "Describes a request item to update a partner shop profile featured listing.", "xml": { "name": "UpdatePartnerShopProfileFeaturedListing" } }, "PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListingsRequest": { "required": [ "updateShopProfileFeaturedListings" ], "type": "object", "properties": { "updateShopProfileFeaturedListings": { "maxItems": 8, "minItems": 1, "type": "array", "description": "A list of featured listings to be updated including the unique identifier and a position ordinal. Max items = 8", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfileFeaturedListing" } } }, "xml": { "name": "UpdatePartnerShopProfileFeaturedListingsRequest" } }, "PartnerProfileService_GetPartnerShopProfileFeaturedListingsResponse": { "required": [ "partnerShopProfileFeaturedListingDetails" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileFeaturedListingDetails": { "type": "array", "description": "The partner shop featured listing details.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileFeaturedListingDetail" } } }, "xml": { "name": "getPartnerShopProfileFeaturedListingsResponse" } }, "PartnerShopProfileService_PartnerShopProfileFeaturedListingDetail": { "required": [ "featuredListingId", "positionOrdinal", "styleImageURL", "styleNumber", "styleTitleDescription" ], "type": "object", "properties": { "featuredListingId": { "type": "string", "description": "The unique code representing a featured listing.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "styleNumber": { "type": "string", "description": "The style number for a featured listing.", "example": "DQK998" }, "styleImageURL": { "type": "string", "description": "The URL for a featured listing's style image.", "example": "https://images.jtv.com/POP35842.jpg" }, "styleTitleDescription": { "type": "string", "description": "The style's title description.", "example": "Black spinel inside-outside hoop earrings 17.10ctw" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of where this featured listing should be displayed in relation to other featured listings. Must be an integer greater than zero and consecutive with all other featured listing .", "format": "int64", "example": 1 } }, "description": "Describes a partner shop profile featured listing.", "xml": { "name": "PartnerShopProfileFeaturedListingDetail" } }, "PartnerProfileService_DeleteShopProfileFeaturedListingsResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deleteShopProfileFeaturedListingsResponse" } }, "PartnerProfileService_CreateShopProfilePolicyResponse": { "required": [ "shopProfilePolicyItemResults" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "profileReturnPeriodId": { "type": "string", "description": "The partner shop profile return period policy id ( uuid ).", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "shopProfilePolicyItemResults": { "type": "array", "description": "The create partner shop profile policy item results.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_ShopProfilePolicyItemResult" } } }, "xml": { "name": "createShopProfilePolicyResponse" } }, "PartnerShopProfileService_ShopProfilePolicyItemResult": { "type": "object", "properties": { "policyItemId": { "type": "string", "description": "The unique policy item id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal representing where this policy item should be rendered in relation to other policy items.", "format": "int64", "example": 10 } }, "description": "Result for each partner shop profile policy item create attempt", "xml": { "name": "shopProfilePolicyItemResult" } }, "PartnerShopProfileService_CreateShopProfilePolicyItem": { "required": [ "policyDescription", "policyTypeCode", "positionOrdinal" ], "type": "object", "properties": { "policyTypeCode": { "pattern": "^[A-Z0-9_]{1,50}$", "type": "string", "description": "The type of profile policy this description is referencing. Allowed [ SHIPPING, PRIVACY, RETURN ]", "example": "SHIPPING" }, "policyDescription": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The description for the policy item, which must be between 1-4000 characters.", "example": "I will pay for shipping and I will ship within 3 business days." }, "positionOrdinal": { "maximum": 999, "minimum": 1, "type": "integer", "description": "The position ordinal of where this policy item should be displayed in relation to other policy items. Must be an unique positive integer <= 999.", "format": "int64", "example": 10 } }, "description": "Describes the partner's shop profile policy.", "xml": { "name": "createShopProfilePolicyItem" } }, "PartnerShopProfileService_CreateShopProfilePolicyRequest": { "type": "object", "properties": { "policyReturnPeriodCode": { "pattern": "^[A-Z0-9_]{1,50}$", "type": "string", "description": "Profile Return Period Code" }, "shopProfilePolicyItems": { "type": "array", "description": "A list of Partner Shop Profile Policy Items", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateShopProfilePolicyItem" } } }, "xml": { "name": "createShopProfilePolicyRequest" } }, "PartnerProfileService_GetShopProfilePolicyResponse": { "required": [ "shopProfilePolicyItems" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileReturnPeriod": { "$ref": "#/components/schemas/PartnerShopProfileService_ShopProfileReturnPeriod" }, "shopProfilePolicyItems": { "type": "array", "description": "The partner shop policy items.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_ShopProfilePolicyItem" } } }, "xml": { "name": "getShopProfilePolicyResponse" } }, "PartnerShopProfileService_ShopProfilePolicyItem": { "required": [ "description", "positionOrdinal", "shopProfilePolicyType" ], "type": "object", "properties": { "shopProfilePolicyType": { "$ref": "#/components/schemas/PartnerShopProfileService_ShopProfilePolicyType" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The description of the policy, which must be between 1-4000 characters.", "example": "The policy description" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of where this policy should be displayed in relation to other policy items. Must be an integer greater than zero and sequential with all other about items.", "format": "int64", "example": 1 }, "lastModifiedDate": { "type": "string", "description": "The date the policy item was modified.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Describes the shop profile policy item.", "xml": { "name": "shopProfilePolicyItem" } }, "PartnerShopProfileService_ShopProfilePolicyType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing policy type. [SHIPPING, PRIVACY, RETURN]", "example": "SHIPPING" }, "name": { "type": "string", "description": "The name representing the profile policy type.", "example": "Shipping" }, "description": { "type": "string", "description": "The description for the profile policy type.", "example": "The policy describes the shop profile shipping policy." } }, "description": "Describes the profile policy type", "xml": { "name": "shopProfilePolicyType" } }, "PartnerShopProfileService_ShopProfileReturnPeriod": { "required": [ "code", "description", "name", "periodInDays" ], "type": "object", "properties": { "code": { "type": "string", "description": "The unique code representing the profile return period.", "example": "90_DAYS" }, "name": { "type": "string", "description": "The name representing the profile return period.", "example": "90 Days" }, "description": { "type": "string", "description": "The description for the profile return period.", "example": "Returns are accepted within 90 Days of Delivery." }, "periodInDays": { "type": "integer", "description": "The profile return period in number of days.", "format": "int32", "example": 90 } }, "description": "Describes the partner shop profile return period", "xml": { "name": "shopProfileReturnPeriod" } }, "PartnerProfileService_UpdatePartnerShopProfileResponse": { "required": [ "partnerShopProfileSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileSummary": { "type": "array", "description": "The partner shop summary profiles.", "xml": { "name": "partnerShopProfileSummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileSummary" } } }, "xml": { "name": "updatePartnerShopProfileResponse" } }, "PartnerShopProfileService_UpdatePartnerShopProfile": { "type": "object", "properties": { "partnerShopProfileGeography": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileGeography" }, "partnerShopProfileDescription": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileDescription" }, "sellerProfileId": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "A reference to a user profile UUID with type SELLER.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "partnerShopProfileCategories": { "type": "array", "description": "The shop profile category code list.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The shop profile category code list.", "xml": { "name": "partnerShopProfileCategory" } } }, "partnerShopProfileLabels": { "type": "array", "description": "The shop profile label code list.", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The shop profile label code list.", "xml": { "name": "partnerShopProfileLabel" } } } }, "description": "The partner shop profile geography, categories, labels, and descriptions", "xml": { "name": "updatePartnerShopProfile" } }, "PartnerShopProfileService_UpdatePartnerShopProfileRequest": { "required": [ "updatePartnerShopProfile" ], "type": "object", "properties": { "updatePartnerShopProfile": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdatePartnerShopProfile" } }, "xml": { "name": "updatePartnerShopProfileRequest" } }, "PartnerProfileService_CreatePartnerShopProfileFaqItemsResponse": { "required": [ "partnerShopProfileFaqItemSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileFaqItemSummary": { "type": "array", "description": "The partner shop FAQ item summaries.", "xml": { "name": "partnerShopProfileFaqItemSummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileFaqItemSummary" } } }, "xml": { "name": "createPartnerShopProfileFaqItemsResponse" } }, "PartnerShopProfileService_PartnerShopProfileFaqItemSummary": { "required": [ "partnerShopProfileFaqItemUuid", "positionOrdinal" ], "type": "object", "properties": { "partnerShopProfileFaqItemUuid": { "type": "string", "description": "The unique code representing a FAQ item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal representing where this FAQ item should be rendered in relation to other FAQ items.", "format": "int32", "example": 1 } }, "description": "Gives topical information to reference an FAQ item.", "xml": { "name": "partnerShopProfileFaqItemSummary" } }, "PartnerShopProfileService_CreatePartnerShopProfileFaqItemsRequest": { "required": [ "partnerShopProfileFaqItems" ], "type": "object", "properties": { "partnerShopProfileFaqItems": { "type": "array", "description": "FAQ items containing a question, answer, and position ordinal for the partner's shop profile.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileFaqItem" } } }, "xml": { "name": "CreatePartnerShopProfileFaqItemsRequest" } }, "PartnerShopProfileService_PartnerShopProfileFaqItem": { "required": [ "answer", "positionOrdinal", "question" ], "type": "object", "properties": { "question": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The question for the FAQ item. Max length 500", "example": "Can I exchange my order?" }, "answer": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The answer for the FAQ item, which must be between 1-4000 characters.", "example": "We do not offer exchanges at this time." }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of where this FAQ item should be displayed in relation to other FAQ items. Must be an integer greater than zero and sequential.", "format": "int32", "example": 1 } }, "description": "Describes the partner's shop profile FAQ Item which contains a question, answer, and position ordinal.", "xml": { "name": "partnerShopProfileFaqItem" } }, "PartnerProfileService_GetPartnerShopProfileFaqItemsResponse": { "required": [ "partnerShopProfileFaqItemDetail" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileFaqItemDetail": { "type": "array", "description": "The partner shop faq item details.", "xml": { "name": "partnerShopProfileFaqItemDetails", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileFaqItemDetail" } } }, "xml": { "name": "getPartnerShopProfileFaqItemsResponse" } }, "PartnerShopProfileService_PartnerShopProfileFaqItemDetail": { "required": [ "answer", "partnerShopProfileFaqItemId", "positionOrdinal", "question" ], "type": "object", "properties": { "partnerShopProfileFaqItemId": { "type": "string", "description": "The unique code representing a FAQ item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "question": { "maxLength": 500, "minLength": 1, "type": "string", "description": "The question for the FAQ item. Max length 500", "example": "Can I exchange my order?" }, "answer": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The answer for the FAQ item, which must be between 1-4000 characters.", "example": "We do not offer exchanges at this time." }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of where this about item should be displayed in relation to other about items. Must be an integer greater than zero and sequential with all other about items.", "format": "int32", "example": 1 }, "lastModifiedDate": { "type": "string", "description": "The date the FAQ was modified.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Describes the partner shop profile FAQ item.", "xml": { "name": "partnerShopProfileFaqItemDetail" } }, "PartnerProfileService_GetPartnerShopProfileExternalLinksResponse": { "required": [ "externalLinks" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "externalLinks": { "type": "array", "description": "The partner shop external link details.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileExternalLinkDetail" } } }, "xml": { "name": "getPartnerShopProfileExternalLinksResponse" } }, "PartnerShopProfileService_PartnerShopProfileExternalLinkDetail": { "required": [ "handle", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing an external link.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "handle": { "type": "string", "description": "The handle of the external link." }, "type": { "$ref": "#/components/schemas/PartnerShopProfileService_ShopProfileExternalLinkType" } }, "description": "Gives detailed information about an external link.", "xml": { "name": "PartnerShopProfileExternalLinkDetail" } }, "PartnerShopProfileService_ShopProfileExternalLinkType": { "required": [ "code", "customType", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the shop profile external link type", "example": "FACEBOOK" }, "name": { "type": "string", "description": "name for the shop profile external link type", "example": "Facebook" }, "description": { "type": "string", "description": "description for the shop profile external link type", "example": "Facebook" }, "displayOrder": { "type": "integer", "description": "display order for the shop profile external link type", "format": "int32", "example": 10 }, "customType": { "type": "boolean", "description": "is the shop profile using a custom external link type", "example": true } }, "description": "Shop Profile External Link Type", "xml": { "name": "shopProfileExternalLinkType" } }, "PartnerProfileService_GetPartnerShopProfileNameAvailabilityResponse": { "required": [ "shopProfileNameAvailability" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileNameAvailability": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileNameAvailability" } }, "xml": { "name": "getPartnerShopProfileNameAvailabilityResponse" } }, "PartnerShopProfileService_PartnerShopProfileNameAvailability": { "required": [ "nameAvailable", "shopProfileName" ], "type": "object", "properties": { "shopProfileName": { "type": "string", "description": "The shop profile name that was provided for the request", "example": "My Super Shop" }, "nameAvailable": { "type": "boolean", "description": "True or false if the given shop profile name is available or not", "example": true }, "unavailableReason": { "type": "string", "description": "A description of why the given shop profile name is not available for use" } }, "description": "Describes the availability of a shop profile name", "xml": { "name": "partnerShopProfileNameAvailability" } }, "PartnerProfileService_UpdateShopProfileStatusResponse": { "required": [ "partnerShopProfileStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileStatus": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileStatus" } }, "xml": { "name": "updateShopProfileStatusResponse" } }, "PartnerShopProfileService_UpdateShopProfileStatusRequest": { "required": [ "statusCode" ], "type": "object", "properties": { "statusCode": { "pattern": "^[A-Z_]{1,50}$", "type": "string", "description": "The required shop profile status: ACTIVATE, DEACTIVATE, VACATION", "example": "ACTIVATE" } }, "xml": { "name": "updateShopProfileStatusRequest" } }, "PartnerProfileService_CreatePartnerShopProfileMediaUploadUriResponse": { "required": [ "apiKey", "folder", "publicId", "signature", "timeStamp", "uploadPreset" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "signature": { "type": "string", "description": "The signature corresponding to the passed in media upload URI parameters." }, "timeStamp": { "type": "integer", "description": "The time stamp corresponding to when the media upload URI parameters were signed.", "format": "int64" }, "folder": { "type": "string", "description": "The folder name where the media should be uploaded." }, "apiKey": { "type": "string", "description": "The api key used for signature signing." }, "uploadPreset": { "type": "string", "description": "The upload preset used for signature signing." }, "publicId": { "type": "string", "description": "The asset's public identifier." } }, "xml": { "name": "createPartnerShopProfileMediaUploadUriResponse" } }, "PartnerShopProfileService_CreatePartnerShopProfileMediaUploadUriRequest": { "required": [ "mediaUploadUriCoordinates", "source" ], "type": "object", "properties": { "mediaUploadUriCoordinates": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaUploadUriCoordinates" }, "source": { "type": "string", "description": "Describes the media upload source", "example": "uw" }, "filenameOverride": { "type": "string", "description": "Describes the filename override used by some Cloudinary widget integrations", "example": "IMG103034.png" }, "headers": { "type": "string", "description": "Describes headers used by some Cloudinary widget integrations", "example": "Dropbox-API-Arg: {\"path\":\"/img_2195.jpg\"} " } }, "xml": { "name": "createPartnerShopProfileMediaUploadUriRequest" } }, "PartnerShopProfileService_MediaUploadUriCoordinates": { "required": [ "coordinates", "mediaUploadUriCoordinateType" ], "type": "object", "properties": { "coordinates": { "pattern": "^[0-9,|]{0,100}$", "type": "string", "description": "The comma separated numerical string representing the requested coordinates", "example": "146,243,932,825" }, "mediaUploadUriCoordinateType": { "type": "string", "description": "The enumerated type representing mutually exclusive coordinate parameters", "enum": [ "CUSTOM_COORDINATES", "FACE_COORDINATES" ] } }, "description": "Describes either the face or custom coordinates parameter", "xml": { "name": "mediaUploadUriCoordinates" } }, "PartnerProfileService_GetShopProfileCompletionStatusResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "informationStatus": { "type": "string", "description": "The partner shop profile information completion status. COMPLETE or INCOMPLETE" }, "aboutItemStatus": { "type": "string", "description": "The partner shop profile about item completion status. COMPLETE or INCOMPLETE" }, "policyStatus": { "type": "string", "description": "The partner shop profile policy completion status. COMPLETE or INCOMPLETE", "xml": { "name": "policyItemStatus" } }, "faqItemStatus": { "type": "string", "description": "The partner shop profile frequenly asked questions (FAQ) completion status. COMPLETE or INCOMPLETE" }, "activationQualifiedStatus": { "type": "string", "description": "The partner shop profile activation qualified completion status. COMPLETE or INCOMPLETE" }, "featuredListingStatus": { "type": "string", "description": "The partner shop profile featured listing completion status. COMPLETE or INCOMPLETE" }, "labelStatus": { "type": "string", "description": "The partner shop profile label completion status. COMPLETE or INCOMPLETE" }, "activeUserProfileStatus": { "type": "string", "description": "The partner shop profile active partner user profile completion status. COMPLETE or INCOMPLETE" } }, "xml": { "name": "getShopProfileCompletionStatusResponse" } }, "PartnerProfileService_GetPartnerShopProfileMediaResponse": { "required": [ "maxMediaItems", "profileNumber", "profileUuid", "totalResultCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "profileUuid": { "type": "string", "description": "The unique code representing the shop profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The profile number." }, "totalResultCount": { "type": "integer", "description": "The number of media items.", "format": "int32", "example": 4 }, "maxMediaItems": { "type": "integer", "description": "The maximum number of media items allowed.", "format": "int32", "example": 12 }, "mediaItems": { "type": "array", "description": "The media items for this style.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaItem" } } }, "xml": { "name": "getPartnerShopProfileMediaResponse" } }, "PartnerShopProfileService_MediaAngle": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "FRONT" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Front" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Front" } }, "description": "The angles of the media item.", "xml": { "name": "mediaAngle" } }, "PartnerShopProfileService_MediaBackground": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "SOLID" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Solid" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Solid color background." } }, "description": "The backgrounds of the media item.", "xml": { "name": "mediaBackground" } }, "PartnerShopProfileService_MediaContentType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "BRAND" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Brand" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Brand" } }, "description": "The content types of the media item.", "xml": { "name": "mediaContentType" } }, "PartnerShopProfileService_MediaCropMode": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media crop mode.", "example": "NO_COORDINATES" }, "name": { "type": "string", "description": "The name representing the media crop mode.", "example": "No Coordinates" }, "description": { "type": "string", "description": "The description for the media crop mode.", "example": "No cropping mode has been applied." } }, "description": "The crop mode of the media item.", "xml": { "name": "mediaCropMode" } }, "PartnerShopProfileService_MediaFormat": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media crop mode.", "example": "JPEG" }, "name": { "type": "string", "description": "The name representing the media crop mode.", "example": "JPEG" }, "description": { "type": "string", "description": "The description for the media crop mode.", "example": "JPEG or JPG" } }, "description": "The file format of the media item.", "xml": { "name": "mediaFormat" } }, "PartnerShopProfileService_MediaItem": { "required": [ "createDate", "deliveryUrl", "lastModifiedByFirstName", "lastModifiedByLastName", "lastModifiedByUser", "moderationStatus", "positionOrdinal", "status", "transformation", "type", "uuid", "verificationStatus" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing the media item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "type": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaType" }, "publicId": { "type": "string", "description": "The public ID of the media item, if stored in Cloudinary." }, "version": { "type": "string", "description": "The version number of the media item, if stored in Cloudinary." }, "deliveryUrl": { "type": "string", "description": "The default delivery URL of the media item." }, "transformation": { "type": "string", "description": "The default transformation used in the delivery URL of the media item." }, "cropMode": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaCropMode" }, "cropCoordinates": { "type": "string", "description": "The crop coordinates of the media item.", "example": "100,200,0,500" }, "originalName": { "type": "string", "description": "The original name of the media item." }, "format": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaFormat" }, "subjects": { "type": "array", "description": "The subjects of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaSubject" } }, "angles": { "type": "array", "description": "The angles of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaAngle" } }, "backgrounds": { "type": "array", "description": "The backgrounds of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaBackground" } }, "contentTypes": { "type": "array", "description": "The content types of the media item.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaContentType" } }, "status": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaStatus" }, "verificationStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaVerifyStatus" }, "moderationStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaModerateStatus" }, "positionOrdinal": { "type": "integer", "description": "The position of this media item within the style.", "format": "int32", "example": 2 }, "mediaCaption": { "type": "string", "description": "The media caption." }, "createDate": { "type": "string", "description": "The date the media item was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "lastModifiedDate": { "type": "string", "description": "The date the media item was last modified since it was created.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" }, "lastModifiedByUser": { "type": "string", "description": "The user name of the user who last modified the media." }, "lastModifiedByFirstName": { "type": "string", "description": "The first name of the user who last modified the media." }, "lastModifiedByLastName": { "type": "string", "description": "The last name of the user who last modified the media." } }, "description": "The media items for this style.", "xml": { "name": "mediaItem" } }, "PartnerShopProfileService_MediaModerateStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "APPROVED" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Approved" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Media has been approved as a result of moderation review." } }, "description": "The moderation status of the media item.", "xml": { "name": "mediaModerateStatus" } }, "PartnerShopProfileService_MediaSubject": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "MODEL" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Model" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Model" } }, "description": "The subjects of the media item.", "xml": { "name": "mediaSubject" } }, "PartnerShopProfileService_MediaVerifyStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "PENDING_VERIFICATION" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Pending Verification" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Media is awaiting verification of conformance with media requirements." } }, "description": "The verification status of the media item.", "xml": { "name": "mediaVerifyStatus" } }, "PartnerProfileService_CreatePartnerShopProfileFeaturedMediaResponse": { "required": [ "partnerShopProfileFeaturedMediaHeaders" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileFeaturedMediaHeaders": { "type": "array", "description": "The partner shop featured media headers.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileFeaturedMediaHeader" } } }, "xml": { "name": "createPartnerShopProfileFeaturedMediaResponse" } }, "PartnerShopProfileService_PartnerShopProfileFeaturedMediaHeader": { "required": [ "featuredMediaUuid", "mediaUuid", "positionOrdinal" ], "type": "object", "properties": { "featuredMediaUuid": { "type": "string", "description": "The unique identifier of the Featured Media item." }, "mediaUuid": { "type": "string", "description": "The unique identifier of the Media Asset." }, "positionOrdinal": { "type": "integer", "description": "The position of this About Media item in the list.", "format": "int64" } }, "description": "Describes the partner's shop profile Featured Media", "xml": { "name": "partnerShopProfileFeaturedMediaHeader" } }, "PartnerShopProfileService_CloudinaryMediaInfo": { "required": [ "publicId", "signature", "uploadUrl", "version" ], "type": "object", "properties": { "publicId": { "type": "string", "description": "The public ID, as returned by Cloudinary" }, "signature": { "type": "string", "description": "The request signature, as returned by Cloudinary" }, "version": { "type": "string", "description": "The version, as returned by Cloudinary" }, "cropMode": { "type": "string", "description": "The crop mode", "enum": [ "NO_COORDINATES", "FACE_COORDINATES", "CUSTOM_COORDINATES" ] }, "uploadUrl": { "type": "string", "description": "The upload URL, as returned by Cloudinary" }, "originalFilename": { "type": "string", "description": "The original filename of the media uploaded to Cloudinary" }, "filenameOverride": { "type": "string", "description": "The filename override in Cloudinary" } }, "description": "Describes Cloudinary-specific info about a media asset", "xml": { "name": "cloudinaryMediaInfo" } }, "PartnerShopProfileService_CreateMediaInfo": { "required": [ "mediaType", "positionOrdinal" ], "type": "object", "properties": { "mediaType": { "type": "string", "description": "The media type", "example": "PHOTO", "enum": [ "PHOTO", "VIDEO", "AUDIO", "DOCUMENT" ] }, "mediaFormat": { "type": "string", "description": "The media format. This value is required only if the media type = DOCUMENT", "example": "PDF" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal for the media in the list", "format": "int32", "example": 2 }, "originalName": { "type": "string", "description": "The media original name" }, "cropCoordinates": { "type": "array", "description": "A list of the crop coordinates of a PHOTO media item", "example": [ 146, 243, 932, 825 ], "xml": { "wrapped": true }, "items": { "type": "integer", "description": "A list of the crop coordinates of a PHOTO media item", "format": "int32", "xml": { "name": "cropCoordinate" } } }, "cloudinaryInfo": { "$ref": "#/components/schemas/PartnerShopProfileService_CloudinaryMediaInfo" } }, "description": "Describes a media item to create/use", "xml": { "name": "createMediaInfo" } }, "PartnerShopProfileService_CreatePartnerShopProfileFeaturedMediaRequest": { "required": [ "partnerShopProfileFeaturedMedia" ], "type": "object", "properties": { "partnerShopProfileFeaturedMedia": { "maxItems": 20, "minItems": 1, "type": "array", "description": "Featured Media items containing a media item and caption, and position ordinal for the partner's shop profile. Max items = 20", "xml": { "name": "partnerShopProfileFeaturedMedias", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileFeaturedMedia" } } }, "xml": { "name": "createPartnerShopProfileFeaturedMediaRequest" } }, "PartnerShopProfileService_PartnerShopProfileFeaturedMedia": { "required": [ "mediaInfo" ], "type": "object", "properties": { "mediaCaption": { "type": "string", "description": "An optional caption describing the media item", "example": "Our Logo" }, "mediaInfo": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateMediaInfo" } }, "description": "Describes the partner's shop profile Featured Media which contains a caption and a media item.", "xml": { "name": "partnerShopProfileFeaturedMedia" } }, "PartnerProfileService_UpdatePartnerShopProfileMediaResponse": { "required": [ "mediaUuids", "profileUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "profileUuid": { "type": "string", "description": "The unique code representing the updated shop profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "mediaUuids": { "type": "array", "description": "The unique code representing the media items that were updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique code representing the media items that were updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "mediaUuid" } } } }, "xml": { "name": "updatePartnerShopProfileMediaResponse" } }, "PartnerShopProfileService_UpdateMediaInfo": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing the media item to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of this media item.", "format": "int32", "example": 2 }, "mediaCaption": { "type": "string", "description": "The caption to user for this media item." }, "subjects": { "type": "array", "description": "The media subject codes", "example": "INDIVIDUAL_PRODUCT", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media subject codes", "example": "INDIVIDUAL_PRODUCT", "xml": { "name": "subject" } } }, "angles": { "type": "array", "description": "The media angle codes", "example": "FRONT", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media angle codes", "example": "FRONT", "xml": { "name": "angle" } } }, "backgrounds": { "type": "array", "description": "The media background codes", "example": "SOLID", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media background codes", "example": "SOLID", "xml": { "name": "background" } } }, "contentTypes": { "type": "array", "description": "The media content type codes", "example": "BRAND", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media content type codes", "example": "BRAND", "xml": { "name": "contentType" } } } }, "description": "The media assets to update for the style", "xml": { "name": "updateMediaInfo" } }, "PartnerShopProfileService_UpdatePartnerShopProfileMediaRequest": { "required": [ "mediaUpdates" ], "type": "object", "properties": { "mediaUpdates": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "The media assets to update for the style", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_UpdateMediaInfo" } } }, "xml": { "name": "updatePartnerShopProfileMediaRequest" } }, "PartnerProfileService_DeletePartnerShopProfileMediaResponse": { "required": [ "shopProfileUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "shopProfileUuid": { "type": "string", "description": "The unique identifier of the shop profile, if the delete is successful" } }, "xml": { "name": "deletePartnerShopProfileMediaResponse" } }, "PartnerProfileService_CreatePartnerShopProfileAboutMediaResponse": { "required": [ "partnerShopProfileAboutMediaHeaders" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileAboutMediaHeaders": { "type": "array", "description": "The partner shop about media headers.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileAboutMediaHeader" } } }, "xml": { "name": "createPartnerShopProfileAboutMediaResponse" } }, "PartnerShopProfileService_PartnerShopProfileAboutMediaHeader": { "required": [ "aboutMediaUuid", "mediaUuid", "positionOrdinal" ], "type": "object", "properties": { "aboutMediaUuid": { "type": "string", "description": "The unique identifier of the About Media item." }, "mediaUuid": { "type": "string", "description": "The unique identifier of the Media Asset." }, "positionOrdinal": { "type": "integer", "description": "The position of this About Media item in the list.", "format": "int64" } }, "description": "Describes the partner's shop profile About Media", "xml": { "name": "partnerShopProfileAboutMediaHeader" } }, "PartnerShopProfileService_CreatePartnerShopProfileAboutMediaRequest": { "required": [ "partnerShopProfileAboutMedia" ], "type": "object", "properties": { "partnerShopProfileAboutMedia": { "maxItems": 20, "minItems": 1, "type": "array", "description": "About Media items containing a media item and caption, and position ordinal for the partner's shop profile. Max items = 20", "xml": { "name": "partnerShopProfileAboutMedias", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileAboutMedia" } } }, "xml": { "name": "createPartnerShopProfileAboutMediaRequest" } }, "PartnerShopProfileService_PartnerShopProfileAboutMedia": { "required": [ "mediaInfo" ], "type": "object", "properties": { "mediaCaption": { "type": "string", "description": "An optional caption describing the media item", "example": "Our Logo" }, "mediaInfo": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateMediaInfo" } }, "description": "Describes the partner's shop profile About Media which contains a caption and a media item.", "xml": { "name": "partnerShopProfileAboutMedia" } }, "PartnerProfileService_CreatePartnerShopProfileMediaResponse": { "required": [ "partnerShopProfileMediaHeader" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerShopProfileMediaHeader": { "$ref": "#/components/schemas/PartnerShopProfileService_PartnerShopProfileMediaHeader" } }, "xml": { "name": "createPartnerShopProfileMediaResponse" } }, "PartnerShopProfileService_PartnerShopProfileMediaHeader": { "required": [ "logoImageMediaUuid", "profileMediaUuid" ], "type": "object", "properties": { "profileMediaUuid": { "type": "string", "description": "The unique identifier of the profile media." }, "logoImageMediaUuid": { "type": "string", "description": "The unique identifier of the logo image media asset." } }, "description": "Describes the partner's shop profile media", "xml": { "name": "partnerShopProfileMediaHeader" } }, "PartnerShopProfileService_CreatePartnerShopProfileMediaRequest": { "required": [ "logoImageInfo" ], "type": "object", "properties": { "logoImageInfo": { "$ref": "#/components/schemas/PartnerShopProfileService_CreateMediaInfo" } }, "xml": { "name": "createPartnerShopProfileMediaRequest" } }, "PartnerSubscriberSubscriptionService_CreateSubscriberSubscriptionInteractionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "subscriberSubscriptionId": { "type": "string", "description": "Subscriber subscription id" } }, "xml": { "name": "createSubscriberSubscriptionResponse" } }, "PartnerSubscriberSubscriptionService_CreateSubscriberSubscription": { "required": [ "communicationPreferences", "subscriberName", "subscriptionOfferingCode" ], "type": "object", "properties": { "subscriberName": { "type": "string", "description": "Subscriber name or nickname", "example": "Susan" }, "communicationPreferences": { "type": "array", "description": "Subscriber communication preferences", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CommunicationPreference" } }, "subscriptionOfferingCode": { "type": "string", "description": "Subscription offering code", "example": "ORDER_TRACKING_NOTIFICATIONS" } }, "description": "The subscriber subscription", "xml": { "name": "createSubscriberSubscription" } }, "PartnerSubscriberSubscriptionService_CreateSubscriberSubscriptionRequest": { "required": [ "createSubscriberSubscription" ], "type": "object", "properties": { "createSubscriberSubscription": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_CreateSubscriberSubscription" } }, "xml": { "name": "createSubscriberSubscriptionRequest" } }, "PartnerSubscriberSubscriptionService_UpdatePartnerSubscriberSubscriptionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updatePartnerSubscriberSubscriptionResponse" } }, "PartnerSubscriberSubscriptionService_BaseSubscriberSubscription": { "required": [ "communicationPreferences", "subscriberName" ], "type": "object", "properties": { "subscriberName": { "type": "string", "description": "Subscriber name or nickname", "example": "Susan" }, "communicationPreferences": { "type": "array", "description": "Subscriber communication preferences", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CommunicationPreference" } } }, "description": "The subscriber subscription", "xml": { "name": "baseSubscriberSubscription" } }, "PartnerSubscriberSubscriptionService_UpdateSubscriberSubscriptionRequest": { "required": [ "updateSubscriberSubscription" ], "type": "object", "properties": { "updateSubscriberSubscription": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_BaseSubscriberSubscription" } }, "xml": { "name": "updateSubscriberSubscriptionRequest" } }, "PartnerSubscriberSubscriptionService_DeletePartnerSubscriberSubscriptionResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "deletePartnerSubscriberSubscriptionResponse" } }, "PartnerSubscriberSubscriptionService_GetPartnerSubscriberSubscriptionResponse": { "required": [ "partnerSubscriberSubscription" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerSubscriberSubscription": { "$ref": "#/components/schemas/PartnerSubscriberSubscriptionService_PartnerSubscriberSubscription" } }, "xml": { "name": "partnerSubscriberSubscriptionResponse" } }, "PartnerSupplierPricingService_CreateSupplierPricingProposalsResponse": { "required": [ "createdProposals" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "createdProposals": { "type": "array", "description": "The created pricing proposals", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerSupplierPricingService_PricingProposal" } } }, "xml": { "name": "createSupplierPricingProposalsResponse" } }, "PartnerSupplierPricingService_PricingProposal": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The UUID of a pricing proposal" } }, "description": "The updated pricing proposals", "xml": { "name": "pricingProposal" } }, "PartnerSupplierPricingService_CreateSupplierPricingProposalsRequest": { "required": [ "service" ], "type": "object", "properties": { "service": { "type": "string", "description": "The code for the service offering to which this pricing proposal applies" }, "stylePricing": { "type": "array", "description": "The style-level pricing proposals", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerSupplierPricingService_SupplierPrice" } }, "skuPricing": { "type": "array", "description": "The sku-level pricing proposals", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerSupplierPricingService_SupplierPrice" } } }, "xml": { "name": "createSupplierPricingProposalsRequest" } }, "PartnerSupplierPricingService_SupplierPrice": { "required": [ "itemNumber", "price" ], "type": "object", "properties": { "itemNumber": { "type": "string", "description": "The style or SKU number of the item being priced", "example": "AWT0001" }, "price": { "type": "number", "description": "The supplier's price (range between 0.0001 and 999999.9999)", "example": 23.52 }, "currencyCode": { "type": "string", "description": "The currency code of the price", "example": "USD", "default": "USD" } }, "description": "The sku-level pricing proposals", "xml": { "name": "price" } }, "PartnerSupplierPricingService_UpdateSupplierPricingProposalsResponse": { "required": [ "updatedProposals" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "updatedProposals": { "type": "array", "description": "The updated pricing proposals", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerSupplierPricingService_PricingProposal" } } }, "xml": { "name": "updateSupplierPricingProposalsResponse" } }, "PartnerSupplierPricingService_PricingProposalUpdate": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The UUID of a pricing proposal" }, "recommendedPrice": { "type": "number", "description": "The recommended price to set on the related SKU when ACCEPTing pricing proposals" } }, "description": "The pricing proposals to update", "xml": { "name": "pricingProposalUpdate" } }, "PartnerSupplierPricingService_UpdateSupplierPricingProposalsRequest": { "required": [ "newStatus" ], "type": "object", "properties": { "newStatus": { "type": "string", "description": "The new status to transition these proposals to", "enum": [ "PENDING_REVIEW", "ACCEPTED", "REJECTED", "EXPIRED", "CANCELLED" ] }, "proposalUpdates": { "type": "array", "description": "The pricing proposals to update", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerSupplierPricingService_PricingProposalUpdate" } }, "rejectNote": { "type": "string", "description": "When REJECTing proposals, a message describing the reason for the rejection" } }, "xml": { "name": "updateSupplierPricingProposalsRequest" } }, "PartnerProfileService_CreateUserProfileResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "createUserProfileResponse" } }, "PartnerShopProfileService_CreateUserProfileRequest": { "required": [ "profileAssociations" ], "type": "object", "properties": { "profileAssociations": { "maxItems": 1, "minItems": 1, "type": "array", "description": "A list profile associations: profile type and association id ", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_UserProfileAssociation" } }, "displayFirstName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The profile display first name", "example": "Monica" }, "displayLastName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The profile display last name", "example": "Smith" }, "titleDescription": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The profile title description", "example": "I am the owner." }, "announcement": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The user profile announcement text", "example": "I will be on vacation in June" }, "birthdayMonthDay": { "pattern": "^[0-1][0-9]/[0-3][0-9]$", "type": "string", "description": "The birthday month and year (MM/DD)", "example": "01/01" }, "genderCode": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The choosen gender code: FEMALE, MALE, RATHER_NOT_SAY", "example": "FEMALE" }, "city": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The city name", "example": "Knoxville" }, "stateProvince": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The state or province name", "example": "Tennessee" }, "country": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The country name", "example": "United States" }, "roleCodes": { "maxItems": 5, "minItems": 0, "type": "array", "description": "A list of the selected profile role codes. Max items = 5", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of the selected profile role codes. Max items = 5", "xml": { "name": "roleCodes" } } }, "specializationCodes": { "maxItems": 8, "minItems": 0, "type": "array", "description": "A list of the selected profile specialization codes. Max items = 8", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of the selected profile specialization codes. Max items = 8", "xml": { "name": "specializationCode" } } } }, "xml": { "name": "createUserProfileRequest" } }, "PartnerShopProfileService_UserProfileAssociation": { "required": [ "profileTypeCode", "uuid" ], "type": "object", "properties": { "profileTypeCode": { "maxLength": 50, "minLength": 1, "type": "string", "description": "The type of profile", "example": "SELLER" }, "uuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The unique identifier (uuid) of the profile association: partnerUuid or associateUuid depending on the profileTypeCode", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "A list profile associations: profile type and association id ", "xml": { "name": "userProfileAssociation" } }, "PartnerUserProfileService_GetPartnerUserProfileResponse": { "required": [ "partnerUserProfile" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerUserProfile": { "$ref": "#/components/schemas/PartnerUserProfileService_partnerUserProfile" } }, "xml": { "name": "getPartnerUserProfileResponse" } }, "PartnerUserProfileService_PartnerUserProfileAssociate": { "required": [ "associateFirstName", "associateId", "associateLastName" ], "type": "object", "properties": { "associateId": { "type": "string", "description": "The unique code representing the associate.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "associateFirstName": { "type": "string", "description": "The associate's first name.", "example": "Steven" }, "associateLastName": { "type": "string", "description": "The associate's last name.", "example": "Stevenson" } }, "description": "Describes the partner user profile's associate'", "xml": { "name": "associate" } }, "PartnerUserProfileService_PartnerUserProfileDescription": { "required": [ "profileBirthdayMonthDay", "profileDisplayFirstName", "profileDisplayLastName", "titleDescription" ], "type": "object", "properties": { "titleDescription": { "type": "string", "description": "The user profile title description.", "example": "Shop Till You Drop" }, "profileDisplayFirstName": { "type": "string", "description": "The profile display first name.", "example": "Joe" }, "profileDisplayLastName": { "type": "string", "description": "The profile display last name.", "example": "Donald" }, "profileBirthdayMonthDay": { "type": "string", "description": "The profile owner's birthday month and day.", "example": "10/15" } }, "description": "Details the user profile's description attributes", "xml": { "name": "partnerUserProfileDescription" } }, "PartnerUserProfileService_PartnerUserProfileGender": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The partner user profile gender code.", "example": "FEMALE" }, "name": { "type": "string", "description": "The partner user profile gender name.", "example": "Female" }, "description": { "type": "string", "description": "The partner user profile gender description.", "example": "The user profile chosen gender is female." } }, "description": "Describes a partner user profile gender'", "xml": { "name": "partnerUserProfileGender" } }, "PartnerUserProfileService_PartnerUserProfileGeography": { "required": [ "cityName", "countryName", "stateProvinceName" ], "type": "object", "properties": { "cityName": { "type": "string", "description": "The user profile's city name.", "example": "Knoxville" }, "stateProvinceName": { "type": "string", "description": "The user profile's state/province name.", "example": "Tennessee" }, "countryName": { "type": "string", "description": "The user profile's country name.", "example": "United States" } }, "description": "Details the user profile's geography description", "xml": { "name": "partnerUserProfileGeography" } }, "PartnerUserProfileService_PartnerUserProfileRevisionStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The partner user profile revision status code.", "example": "PUBLISHED" }, "name": { "type": "string", "description": "The partner user profile revision status name.", "example": "Published" }, "description": { "type": "string", "description": "The partner user profile revision status description.", "example": "The profile revision has been published to the Storefront." } }, "description": "Describes a partner user profile revision status", "xml": { "name": "partnerUserProfileRevisionStatus" } }, "PartnerUserProfileService_PartnerUserProfileRole": { "required": [ "code", "description", "name", "positionOrdinal" ], "type": "object", "properties": { "code": { "type": "string", "description": "The partner user profile role code.", "example": "FASHION_DESIGNER" }, "name": { "type": "string", "description": "The partner user profile role name.", "example": "Fashion Designer" }, "description": { "type": "string", "description": "The partner user profile role description.", "example": "Fashion Designer" }, "positionOrdinal": { "type": "integer", "description": "The partner user profile role position ordinal.", "format": "int64", "example": 10 } }, "description": "Describes a partner user profile role'", "xml": { "name": "partnerUserProfileRole" } }, "PartnerUserProfileService_PartnerUserProfileSpecialization": { "required": [ "code", "description", "name", "positionOrdinal" ], "type": "object", "properties": { "code": { "type": "string", "description": "The partner user profile specialization code.", "example": "LOOSE_GEMSTONES" }, "name": { "type": "string", "description": "The partner user profile specialization name.", "example": "Loose Gemstones" }, "description": { "type": "string", "description": "The partner user profile specialization description.", "example": "Loose Gemstones" }, "positionOrdinal": { "type": "integer", "description": "The partner user profile specialization position ordinal.", "format": "int64", "example": 10 } }, "description": "Describes a partner user profile specialization", "xml": { "name": "partnerUserProfileSpecialization" } }, "PartnerUserProfileService_PartnerUserProfileStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The partner user profile status code.", "example": "ACTIVE" }, "name": { "type": "string", "description": "The partner user profile status name.", "example": "Active" }, "description": { "type": "string", "description": "The partner user profile status description.", "example": "The profile has been activated, and therefore may be displayed on the Storefront." } }, "description": "Describes a partner user profile status'", "xml": { "name": "partnerUserProfileStatus" } }, "PartnerUserProfileService_PartnerUserProfileType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The partner user profile type code.", "example": "ASSOCIATE" }, "name": { "type": "string", "description": "The partner user profile type name.", "example": "Associate" }, "description": { "type": "string", "description": "The partner user profile type description.", "example": "The user profile belongs to a Partner Associate" } }, "description": "Describes the partner user profile type", "xml": { "name": "partnerUserProfileType" } }, "PartnerUserProfileService_partnerUserProfile": { "required": [ "associate", "partnerUserProfileDescription", "partnerUserProfileGender", "partnerUserProfileGeography", "partnerUserProfileRevisionStatus", "partnerUserProfileRoles", "partnerUserProfileSpecializations", "partnerUserProfileStatus", "profileId", "profileNumber", "profileTypes" ], "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique code representing an existing profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The unique profile number.", "example": "S1HW5505" }, "profileLogoImageUrl": { "type": "string", "description": "The delivery URL of the profile logo image." }, "profileTypes": { "type": "array", "description": "The partner user profile.", "xml": { "name": "partnerUserProfiles", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileType" } }, "associate": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileAssociate" }, "partnerUserProfileDescription": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileDescription" }, "partnerUserProfileGeography": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileGeography" }, "partnerUserProfileRoles": { "type": "array", "description": "The partner user profile's roles.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileRole" } }, "partnerUserProfileSpecializations": { "type": "array", "description": "The partner user profile's specialization.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileSpecialization" } }, "partnerUserProfileStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileStatus" }, "partnerUserProfileRevisionStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileRevisionStatus" }, "partnerUserProfileGender": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileGender" } }, "description": "Describes the partner user profile", "xml": { "name": "partnerUserProfile" } }, "PartnerUserProfileService_GetPartnerUserProfileCompletionStatusResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "informationStatus": { "type": "string", "description": "The partner user profile information completion status. COMPLETE or INCOMPLETE" }, "aboutItemStatus": { "type": "string", "description": "The partner user profile about item completion status. COMPLETE or INCOMPLETE" }, "aboutMediaStatus": { "type": "string", "description": "The partner user profile About Media completion status. COMPLETE or INCOMPLETE" }, "featuredMediaStatus": { "type": "string", "description": "The partner user profile featured media completion status. COMPLETE or INCOMPLETE" } }, "xml": { "name": "getPartnerUserProfileCompletionStatusResponse" } }, "PartnerUserProfileService_UpdateUserProfileStatusResponse": { "required": [ "profileStatus" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "profileStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileStatus" } }, "xml": { "name": "updateUserProfileStatusResponse" } }, "PartnerShopProfileService_UpdateUserProfileStatusRequest": { "required": [ "statusCode" ], "type": "object", "properties": { "statusCode": { "pattern": "^[A-Z]{1,50}$", "type": "string", "description": "The required user profile status: ACTIVE, DEACTIVATED", "example": "ACTIVE" } }, "xml": { "name": "updateUserProfileStatusRequest" } }, "PartnerUserProfileService_GetPartnerUserProfilesResponse": { "required": [ "userProfiles" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "userProfiles": { "type": "array", "description": "User Profiles", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_partnerUserProfileBasic" } } }, "xml": { "name": "getPartnerUserProfilesResponse" } }, "PartnerUserProfileService_partnerUserProfileBasic": { "required": [ "associate", "partnerUserProfileRevisionStatus", "partnerUserProfileRoles", "partnerUserProfileSpecializations", "partnerUserProfileStatus", "profileDisplayFirstName", "profileDisplayLastName", "profileId", "profileNumber", "profileType", "profileTypes" ], "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique code representing an existing profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The unique profile number.", "example": "S1HW5505" }, "profileDisplayFirstName": { "type": "string", "description": "The profile display first name.", "example": "Joe" }, "birthdayMonthDay": { "type": "string", "description": "The profile owner's birthday month day.", "example": "10/15" }, "profileDisplayLastName": { "type": "string", "description": "The profile display last name.", "example": "Donald" }, "profileLogoImageUrl": { "type": "string", "description": "The URL of the profile logo image." }, "profileType": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileType" }, "profileTypes": { "type": "array", "description": "The partner user profile types.", "xml": { "name": "partnerUserProfileTypes", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileType" } }, "associate": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileAssociate" }, "partnerUserProfileRoles": { "type": "array", "description": "The partner user profile's roles.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileRole" } }, "partnerUserProfileSpecializations": { "type": "array", "description": "The partner user profile's specialization.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileSpecialization" } }, "partnerUserProfileStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileStatus" }, "partnerUserProfileRevisionStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileRevisionStatus" } }, "description": "A simple description of the partner user profile", "xml": { "name": "partnerUserProfileBasic" } }, "profile-type-code": { "type": "array", "description": "The profile type code. If provided the API will only return profiles that have given profile type code.", "example": "SELLER", "items": { "type": "string", "description": "The profile type code. If provided the API will only return profiles that have given profile type code.", "example": "SELLER" } }, "PartnerUserProfileService_UpdatePartnerUserProfileResponse": { "required": [ "userProfileSummary" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "userProfileSummary": { "type": "array", "description": "The partner user profile summary.", "xml": { "name": "userProfileSummarySummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_UserProfileSummary" } } }, "xml": { "name": "UpdatePartnerUserProfileResponse" } }, "PartnerUserProfileService_UserProfileStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the user profile status.", "example": "PENDING_ACTIVATION" }, "name": { "type": "string", "description": "The name representing the user profile status.", "example": "Pending Activation" }, "description": { "type": "string", "description": "The description for the user profile status.", "example": "The profile is pending activation." } }, "description": "Describes the userprofile status", "xml": { "name": "UserProfileStatus" } }, "PartnerUserProfileService_UserProfileSummary": { "required": [ "profileId", "profileNumber", "userProfileStatus", "userProfileTypes" ], "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique uuid representing the created user profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The unique profileNumber representing the created user profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "userProfileStatus": { "$ref": "#/components/schemas/PartnerUserProfileService_UserProfileStatus" }, "userProfileTypes": { "type": "array", "description": "The user profile type.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_UserProfileType" } } }, "description": "Describes the profile summary", "xml": { "name": "userProfileSummary" } }, "PartnerUserProfileService_UserProfileType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the user profile type.", "example": "SELLER" }, "name": { "type": "string", "description": "The name representing the user profile type.", "example": "Seller" }, "description": { "type": "string", "description": "The description for the user profile type.", "example": "The profile is for a Seller" } }, "description": "Describes the user profile type", "xml": { "name": "UserProfileType" } }, "PartnerUserProfileService_UpdatePartnerUserProfileRequest": { "type": "object", "properties": { "displayFirstName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The user profile display first name", "example": "Phoebe" }, "displayLastName": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The user profile display last name", "example": "Ferrari" }, "titleDescription": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The user profile title description", "example": "I am the owner." }, "birthdayMonthDay": { "pattern": "^[0-1][0-9]/[0-3][0-9]$", "type": "string", "description": "NOT REQUIRED: The birthday month and year (MM/DD)", "example": "01/01" }, "genderCode": { "maxLength": 50, "minLength": 1, "type": "string", "description": "NOT REQUIRED: The choosen gender code: FEMALE, MALE, RATHER_NOT_SAY", "example": "FEMALE" }, "city": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The city name", "example": "Knoxville" }, "stateProvince": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The state or province name", "example": "Tennessee" }, "country": { "maxLength": 100, "minLength": 0, "type": "string", "description": "The country name", "example": "United States" }, "roleCodes": { "maxItems": 5, "minItems": 0, "type": "array", "description": "A list of the selected profile role codes. Max items = 5", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of the selected profile role codes. Max items = 5", "xml": { "name": "roleCode" } } }, "specializationCodes": { "maxItems": 8, "minItems": 0, "type": "array", "description": "A list of the selected profile specialization codes. Max items = 8", "xml": { "wrapped": true }, "items": { "type": "string", "description": "A list of the selected profile specialization codes. Max items = 8", "xml": { "name": "specializationCode" } } } }, "xml": { "name": "UpdatePartnerUserProfileRequest" } }, "PartnerUserProfileService_GetPartnerUserProfileMediaResponse": { "required": [ "maxMediaItems", "profileNumber", "profileUuid", "totalResultCount" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "profileUuid": { "type": "string", "description": "The unique code representing the shop profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "profileNumber": { "type": "string", "description": "The profile number." }, "totalResultCount": { "type": "integer", "description": "The number of media items.", "format": "int32", "example": 4 }, "maxMediaItems": { "type": "integer", "description": "The maximum number of media items allowed.", "format": "int32", "example": 12 }, "mediaItems": { "type": "array", "description": "The media items for this style.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerShopProfileService_MediaItem" } } }, "xml": { "name": "getPartnerUserProfileMediaResponse" } }, "PartnerUserProfileService_MediaAngle": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "FRONT" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Front" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Front" } }, "description": "The angles of the media item.", "xml": { "name": "mediaAngle" } }, "PartnerUserProfileService_MediaBackground": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "SOLID" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Solid" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Solid color background." } }, "description": "The backgrounds of the media item.", "xml": { "name": "mediaBackground" } }, "PartnerUserProfileService_MediaContentType": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "BRAND" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Brand" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Brand" } }, "description": "The content types of the media item.", "xml": { "name": "mediaContentType" } }, "PartnerUserProfileService_MediaCropMode": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media crop mode.", "example": "NO_COORDINATES" }, "name": { "type": "string", "description": "The name representing the media crop mode.", "example": "No Coordinates" }, "description": { "type": "string", "description": "The description for the media crop mode.", "example": "No cropping mode has been applied." } }, "description": "The crop mode of the media item.", "xml": { "name": "mediaCropMode" } }, "PartnerUserProfileService_MediaFormat": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media crop mode.", "example": "JPEG" }, "name": { "type": "string", "description": "The name representing the media crop mode.", "example": "JPEG" }, "description": { "type": "string", "description": "The description for the media crop mode.", "example": "JPEG or JPG" } }, "description": "The file format of the media item.", "xml": { "name": "mediaFormat" } }, "PartnerUserProfileService_MediaModerateStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "APPROVED" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Approved" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Media has been approved as a result of moderation review." } }, "description": "The moderation status of the media item.", "xml": { "name": "mediaModerateStatus" } }, "PartnerUserProfileService_MediaSubject": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "MODEL" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Model" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Model" } }, "description": "The subjects of the media item.", "xml": { "name": "mediaSubject" } }, "PartnerUserProfileService_MediaVerifyStatus": { "required": [ "code", "description", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The code representing the media status.", "example": "PENDING_VERIFICATION" }, "name": { "type": "string", "description": "The name representing the media status.", "example": "Pending Verification" }, "description": { "type": "string", "description": "The description for the media status.", "example": "Media is awaiting verification of conformance with media requirements." } }, "description": "The verification status of the media item.", "xml": { "name": "mediaVerifyStatus" } }, "PartnerUserProfileService_CreatePartnerUserProfileAboutMediaResponse": { "required": [ "partnerUserProfileAboutMediaHeaders" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerUserProfileAboutMediaHeaders": { "type": "array", "description": "The partner user about media headers.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerShopProfileAboutMediaHeader" } } }, "xml": { "name": "createPartnerUserProfileAboutMediaResponse" } }, "PartnerUserProfileService_PartnerShopProfileAboutMediaHeader": { "required": [ "aboutMediaUuid", "mediaUuid", "positionOrdinal" ], "type": "object", "properties": { "aboutMediaUuid": { "type": "string", "description": "The unique identifier of the About Media item." }, "mediaUuid": { "type": "string", "description": "The unique identifier of the Media Asset." }, "positionOrdinal": { "type": "integer", "description": "The position of this About Media item in the list.", "format": "int64" } }, "description": "Describes the partner's user profile About Media", "xml": { "name": "partnerUserProfileAboutMediaHeader" } }, "PartnerUserProfileService_CloudinaryMediaInfo": { "required": [ "publicId", "signature", "uploadUrl", "version" ], "type": "object", "properties": { "publicId": { "type": "string", "description": "The public ID, as returned by Cloudinary" }, "signature": { "type": "string", "description": "The request signature, as returned by Cloudinary" }, "version": { "type": "string", "description": "The version, as returned by Cloudinary" }, "cropMode": { "type": "string", "description": "The crop mode", "enum": [ "NO_COORDINATES", "FACE_COORDINATES", "CUSTOM_COORDINATES" ] }, "uploadUrl": { "type": "string", "description": "The upload URL, as returned by Cloudinary" }, "originalFilename": { "type": "string", "description": "The original filename of the media uploaded to Cloudinary" }, "filenameOverride": { "type": "string", "description": "The filename override in Cloudinary" } }, "description": "Describes Cloudinary-specific info about a media asset", "xml": { "name": "cloudinaryMediaInfo" } }, "PartnerUserProfileService_CreateMediaInfo": { "required": [ "mediaType", "positionOrdinal" ], "type": "object", "properties": { "mediaType": { "type": "string", "description": "The media type", "example": "PHOTO", "enum": [ "PHOTO", "VIDEO", "AUDIO", "DOCUMENT" ] }, "mediaFormat": { "type": "string", "description": "The media format. This value is required only if the media type = DOCUMENT", "example": "PDF" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal for the media in the list", "format": "int32", "example": 2 }, "originalName": { "type": "string", "description": "The media original name" }, "cropCoordinates": { "type": "array", "description": "A list of the crop coordinates of a PHOTO media item", "example": [ 146, 243, 932, 825 ], "xml": { "wrapped": true }, "items": { "type": "integer", "description": "A list of the crop coordinates of a PHOTO media item", "format": "int32", "xml": { "name": "cropCoordinate" } } }, "cloudinaryInfo": { "$ref": "#/components/schemas/PartnerUserProfileService_CloudinaryMediaInfo" } }, "description": "Describes a media item to create/use", "xml": { "name": "createMediaInfo" } }, "PartnerUserProfileService_CreatePartnerUserProfileAboutMediaRequest": { "required": [ "partnerUserProfileAboutMedia" ], "type": "object", "properties": { "partnerUserProfileAboutMedia": { "maxItems": 20, "minItems": 1, "type": "array", "description": "About Media items containing a media item and caption, and position ordinal for the partner's user profile. Max items = 20", "xml": { "name": "partnerUserProfileAboutMedias", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerShopProfileAboutMedia" } } }, "xml": { "name": "createPartnerUserProfileAboutMediaRequest" } }, "PartnerUserProfileService_PartnerShopProfileAboutMedia": { "required": [ "mediaInfo" ], "type": "object", "properties": { "mediaCaption": { "type": "string", "description": "An optional caption describing the media item", "example": "Our Logo" }, "mediaInfo": { "$ref": "#/components/schemas/PartnerUserProfileService_CreateMediaInfo" } }, "description": "Describes the partner's user profile About Media which contains a caption and a media item.", "xml": { "name": "partnerUserProfileAboutMedia" } }, "PartnerUserProfileService_UpdatePartnerUserProfileMediaResponse": { "required": [ "mediaUuids", "profileUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "profileUuid": { "type": "string", "description": "The unique code representing the updated user profile.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "mediaUuids": { "type": "array", "description": "The unique code representing the media items that were updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The unique code representing the media items that were updated.", "example": "889e6036-34ce-494d-b7da-d06b213583d6", "xml": { "name": "mediaUuid" } } } }, "xml": { "name": "updatePartnerUserProfileMediaResponse" } }, "PartnerUserProfileService_UpdateMediaInfo": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing the media item to update.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of this media item.", "format": "int32", "example": 2 }, "mediaCaption": { "type": "string", "description": "The caption to user for this media item." }, "subjects": { "type": "array", "description": "The media subject codes", "example": "INDIVIDUAL_PRODUCT", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media subject codes", "example": "INDIVIDUAL_PRODUCT", "xml": { "name": "subject" } } }, "angles": { "type": "array", "description": "The media angle codes", "example": "FRONT", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media angle codes", "example": "FRONT", "xml": { "name": "angle" } } }, "backgrounds": { "type": "array", "description": "The media background codes", "example": "SOLID", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media background codes", "example": "SOLID", "xml": { "name": "background" } } }, "contentTypes": { "type": "array", "description": "The media content type codes", "example": "BRAND", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The media content type codes", "example": "BRAND", "xml": { "name": "contentType" } } } }, "description": "The media assets to update for the style", "xml": { "name": "updateMediaInfo" } }, "PartnerUserProfileService_UpdatePartnerUserProfileMediaRequest": { "required": [ "mediaUpdates" ], "type": "object", "properties": { "mediaUpdates": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "The media assets to update for the style", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_UpdateMediaInfo" } } }, "xml": { "name": "UpdatePartnerUserProfileMediaRequest" } }, "PartnerProfileService_DeletePartnerUserProfileMediaResponse": { "required": [ "userProfileUuid" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "userProfileUuid": { "type": "string", "description": "The unique identifier of the user profile, if the delete is successful" } }, "xml": { "name": "deletePartnerShopProfileMediaResponse" } }, "PartnerUserProfileService_CreatePartnerUserProfileFeaturedMediaResponse": { "required": [ "partnerUserProfileFeaturedMediaHeaders" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerUserProfileFeaturedMediaHeaders": { "type": "array", "description": "The partner user featured media headers.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileFeaturedMediaHeader" } } }, "xml": { "name": "createPartnerUserProfileFeaturedMediaResponse" } }, "PartnerUserProfileService_PartnerUserProfileFeaturedMediaHeader": { "required": [ "featuredMediaUuid", "mediaUuid", "positionOrdinal" ], "type": "object", "properties": { "featuredMediaUuid": { "type": "string", "description": "The unique identifier of the Featured Media item." }, "mediaUuid": { "type": "string", "description": "The unique identifier of the Media Asset." }, "positionOrdinal": { "type": "integer", "description": "The position of this About Media item in the list.", "format": "int64" } }, "description": "Describes the partner's user profile Featured Media", "xml": { "name": "partnerUserProfileFeaturedMediaHeader" } }, "PartnerUserProfileService_CreatePartnerUserProfileFeaturedMediaRequest": { "required": [ "partnerUserProfileFeaturedMedia" ], "type": "object", "properties": { "partnerUserProfileFeaturedMedia": { "maxItems": 20, "minItems": 1, "type": "array", "description": "Featured Media items containing a media item and caption, and position ordinal for the partner's user profile. Max items = 20", "xml": { "name": "partnerUserProfileFeaturedMedias", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileFeaturedMedia" } } }, "xml": { "name": "createPartnerUserProfileFeaturedMediaRequest" } }, "PartnerUserProfileService_PartnerUserProfileFeaturedMedia": { "required": [ "mediaInfo" ], "type": "object", "properties": { "mediaCaption": { "type": "string", "description": "An optional caption describing the media item", "example": "Our Logo" }, "mediaInfo": { "$ref": "#/components/schemas/PartnerUserProfileService_CreateMediaInfo" } }, "description": "Describes the partner's user profile Featured Media which contains a caption and a media item.", "xml": { "name": "partnerUserProfileFeaturedMedia" } }, "PartnerUserProfileService_CreatePartnerUserProfileAboutItemsResponse": { "required": [ "partnerUserProfileAboutItemSummaries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerUserProfileAboutItemSummaries": { "type": "array", "description": "The partner user profile about me item summaries.", "xml": { "name": "userProfileAboutMeItemSummaries", "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileAboutItemSummary" } } }, "xml": { "name": "createPartnerUserProfileAboutItemsResponse" } }, "PartnerUserProfileService_PartnerUserProfileAboutItemSummary": { "required": [ "positionOrdinal", "userProfileAboutMeItemId" ], "type": "object", "properties": { "userProfileAboutMeItemId": { "type": "string", "description": "The unique code representing an user profile about me item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "positionOrdinal": { "type": "integer", "description": "The position ordinal representing where this about item should be rendered in relation to other about items.", "format": "int64", "example": 1 } }, "description": "Gives topical information to reference an user profile about me item.", "xml": { "name": "partnerUserProfileAboutItemSummary" } }, "PartnerUserProfileService_CreatePartnerUserProfileAboutItemsRequest": { "required": [ "partnerUserProfileAboutItems" ], "type": "object", "properties": { "partnerUserProfileAboutItems": { "maxItems": 5, "minItems": 0, "type": "array", "description": "About items containing a headline, description, and position ordinal for the partner's user profile. Max items = 5", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileAboutItem" } } }, "xml": { "name": "createPartnerUserProfileAboutItemsRequest" } }, "PartnerUserProfileService_PartnerUserProfileAboutItem": { "required": [ "description", "headline", "positionOrdinal" ], "type": "object", "properties": { "headline": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The headline for the about item, which must be between 1-200 characters.", "example": "My Story" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The description for the about item, which must be between 1-4000 characters.", "example": "Born as a dairy farmers, my sister and I discovered radioactive gemstones on our farm. We used those gemstones to give ourselves magical abilities capable of selling jewelry on awesome ecommerce marketplaces." }, "positionOrdinal": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "The position ordinal of where this about item should be displayed in relation to other about items. Must be an integer greater than zero and sequential with all other about items.", "format": "int64", "example": 10 } }, "description": "Describes the partner's user profile About Item which contains a headline, description, and position ordinal.", "xml": { "name": "partnerUserProfileAboutItem" } }, "PartnerUserProfileService_GetPartnerUserProfileAboutItemsResponse": { "required": [ "partnerUserProfileAboutItemDetails" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerUserProfileAboutItemDetails": { "type": "array", "description": "The partner user about item details.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileAboutItemDetail" } } }, "xml": { "name": "getPartnerUserProfileAboutItemsResponse" } }, "PartnerUserProfileService_PartnerUserProfileAboutItemDetail": { "required": [ "description", "headline", "positionOrdinal", "userProfileAboutMeItemId" ], "type": "object", "properties": { "userProfileAboutMeItemId": { "type": "string", "description": "The unique code representing an user profile about me item.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "headline": { "maxLength": 200, "minLength": 1, "type": "string", "description": "The headline for the about item, which must be between 1-200 characters.", "example": "My Story" }, "description": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "The description for the about item, which must be between 1-4000 characters.", "example": "Born as a dairy farmers, my sister and I discovered radioactive gemstones on our farm. We used those gemstones to give ourselves magical abilities capable of selling jewelry on awesome ecommerce marketplaces." }, "positionOrdinal": { "type": "integer", "description": "The position ordinal of where this about item should be displayed in relation to other about items. Must be an integer greater than zero and sequential with all other about items.", "format": "int32", "example": 1 } }, "description": "Describes the partner user profile about me item.", "xml": { "name": "partnerUserProfileAboutItemDetail" } }, "PartnerProfileService_CreatePartnerUserProfileExternalLinkResponse": { "required": [ "externalLinkSummaries" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "externalLinkSummaries": { "type": "array", "description": "The partner user profile external link summaries.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerUserProfileExternalLinkSummary" } } }, "xml": { "name": "createPartnerUserProfileExternalLinkResponse" } }, "PartnerProfileService_PartnerUserProfileExternalLinkSummary": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing an external link.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "description": "Gives topical information to reference an external link.", "xml": { "name": "PartnerUserProfileExternalLinkSummary" } }, "PartnerProfileService_CreatePartnerUserProfileExternalLinkRequest": { "type": "object", "properties": { "externalLinks": { "type": "array", "description": "A list of external links containing a type code and handle for the partner's user profile. May be empty if you wish to remove all existing external links.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerUserProfileExternalLink" } } }, "xml": { "name": "createPartnerUserProfileExternalLinkRequest" } }, "PartnerProfileService_PartnerUserProfileExternalLink": { "required": [ "handle", "typeCode" ], "type": "object", "properties": { "handle": { "maxLength": 2000, "minLength": 1, "type": "string", "description": "The handle (for social media links) or full URL (for custom links) of the external link.", "example": "@bestRingShop" }, "typeCode": { "pattern": "^FACEBOOK|YOUTUBE|INSTAGRAM|PINTEREST|TWITTER|CUSTOM_WEBSITE$", "type": "string", "description": "The type code of the external link", "example": "FACEBOOK", "enum": [ "FACEBOOK", "YOUTUBE", "INSTAGRAM", "PINTEREST", "TWITTER", "CUSTOM_WEBSITE" ] } }, "description": "Describes the partner's user profile External Link.", "xml": { "name": "partnerUserProfileExternalLink" } }, "PartnerProfileService_GetPartnerUserProfileExternalLinkResponse": { "required": [ "externalLinks" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "externalLinks": { "type": "array", "description": "The partner user external link details.", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/PartnerProfileService_PartnerUserProfileExternalLinkDetail" } } }, "xml": { "name": "getPartnerUserProfileExternalLinkResponse" } }, "PartnerProfileService_PartnerUserProfileExternalLinkDetail": { "required": [ "handle", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique code representing an external link.", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "handle": { "type": "string", "description": "The handle of the external link." }, "type": { "$ref": "#/components/schemas/PartnerProfileService_UserProfileExternalLinkType" } }, "description": "Gives detailed information about an external link.", "xml": { "name": "PartnerUserProfileExternalLinkDetail" } }, "PartnerProfileService_UserProfileExternalLinkType": { "required": [ "code", "customType", "description", "displayOrder", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "code for the user profile external link type", "example": "FACEBOOK" }, "name": { "type": "string", "description": "name for the user profile external link type", "example": "Facebook" }, "description": { "type": "string", "description": "description for the user profile external link type", "example": "Facebook" }, "displayOrder": { "type": "integer", "description": "display order for the user profile external link type", "format": "int32", "example": 10 }, "customType": { "type": "boolean", "description": "is the user profile using a custom external link type", "example": true } }, "description": "User Profile External Link Type", "xml": { "name": "userProfileExternalLinkType" } }, "PartnerUserProfileService_CreatePartnerUserProfileMediaUploadUriResponse": { "required": [ "apiKey", "folder", "publicId", "signature", "timeStamp", "uploadPreset" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "signature": { "type": "string", "description": "The signature corresponding to the passed in media upload URI parameters." }, "timeStamp": { "type": "integer", "description": "The time stamp corresponding to when the media upload URI parameters were signed.", "format": "int64" }, "folder": { "type": "string", "description": "The folder name where the media should be uploaded." }, "apiKey": { "type": "string", "description": "The api key used for signature signing." }, "uploadPreset": { "type": "string", "description": "The upload preset used for signature signing." }, "publicId": { "type": "string", "description": "The asset's public identifier." } }, "xml": { "name": "createPartnerUserProfileMediaUploadUriResponse" } }, "PartnerUserProfileService_CreatePartnerUserProfileMediaUploadUriRequest": { "required": [ "mediaUploadUriCoordinates", "source" ], "type": "object", "properties": { "mediaUploadUriCoordinates": { "$ref": "#/components/schemas/PartnerUserProfileService_MediaUploadUriCoordinates" }, "source": { "type": "string", "description": "Describes the media upload source", "example": "uw" }, "filenameOverride": { "type": "string", "description": "Describes the filename override used by some Cloudinary widget integrations", "example": "IMG103034.png" }, "headers": { "type": "string", "description": "Describes headers used by some Cloudinary widget integrations", "example": "Dropbox-API-Arg: {\"path\":\"/img_2195.jpg\"} " } }, "xml": { "name": "createPartnerUserProfileMediaUploadUriRequest" } }, "PartnerUserProfileService_MediaUploadUriCoordinates": { "required": [ "coordinates", "mediaUploadUriCoordinateType" ], "type": "object", "properties": { "coordinates": { "pattern": "^[0-9,|]{0,100}$", "type": "string", "description": "The comma separated numerical string representing the requested coordinates", "example": "146,243,932,825" }, "mediaUploadUriCoordinateType": { "type": "string", "description": "The enumerated type representing mutually exclusive coordinate parameters", "enum": [ "CUSTOM_COORDINATES", "FACE_COORDINATES" ] } }, "description": "Describes either the face or custom coordinates parameter", "xml": { "name": "mediaUploadUriCoordinates" } }, "PartnerUserProfileService_CreatePartnerUserProfileMediaResponse": { "required": [ "partnerUserProfileMediaHeader" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "partnerUserProfileMediaHeader": { "$ref": "#/components/schemas/PartnerUserProfileService_PartnerUserProfileMediaHeader" } }, "xml": { "name": "createPartnerUserProfileMediaResponse" } }, "PartnerUserProfileService_PartnerUserProfileMediaHeader": { "required": [ "logoImageMediaUuid", "profileMediaUuid" ], "type": "object", "properties": { "profileMediaUuid": { "type": "string", "description": "The unique identifier of the profile media." }, "logoImageMediaUuid": { "type": "string", "description": "The unique identifier of the logo image media asset." } }, "description": "Describes the partner's user profile media", "xml": { "name": "partnerUserProfileMediaHeader" } }, "PartnerUserProfileService_CreatePartnerUserProfileMediaRequest": { "required": [ "logoImageInfo" ], "type": "object", "properties": { "logoImageInfo": { "$ref": "#/components/schemas/PartnerUserProfileService_CreateMediaInfo" } }, "xml": { "name": "createPartnerUserProfileMediaRequest" } }, "GetConfigurator_Choice": { "type": "object", "properties": { "choiceUuid": { "type": "string" }, "choiceName": { "type": "string" }, "choiceDescription": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "choiceGroup": { "$ref": "#/components/schemas/GetConfigurator_ChoiceGroup" }, "resourceName": { "type": "string" }, "configChoiceDescription": { "type": "string" }, "validConfiguratorPickChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ValidConfiguratorPickChoice" } }, "validPrebuiltPickChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ValidConfiguratorPickChoice" } } }, "xml": { "name": "Choice" } }, "GetConfigurator_ChoiceGroup": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "ChoiceGroup" } }, "GetConfigurator_Component": { "type": "object", "properties": { "componentUuid": { "type": "string" }, "isBase": { "type": "boolean" }, "componentProductStyleList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ComponentProductStyle" } } }, "xml": { "name": "Component" } }, "GetConfigurator_ComponentGroup": { "type": "object", "properties": { "componentGroupUuid": { "type": "string" }, "componentGroupName": { "type": "string" }, "componentList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_Component" } }, "configuratorPickUuidList": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "string", "xml": { "name": "configuratorPickUuid" } } } }, "xml": { "name": "ComponentGroup" } }, "GetConfigurator_ComponentProductSku": { "type": "object", "properties": { "skuId": { "type": "string", "description": "An internal product sku identifier", "example": "12345" }, "size": { "type": "number", "description": "The product sku's size" }, "quantityAvailable": { "type": "integer", "format": "int32" }, "sellingPriceInCents": { "type": "number", "format": "double" } }, "xml": { "name": "ComponentProductSku" } }, "GetConfigurator_ComponentProductStyle": { "type": "object", "properties": { "componentProductStyleUuid": { "type": "string", "description": "The component style uuid" }, "masterId": { "type": "integer", "description": "An internal product style identifier", "format": "int32", "example": 12345 }, "styleId": { "type": "string", "description": "The product style external id (it is master sku in the old product model taxonomy)", "example": "DQK998Y" }, "description": { "type": "string", "description": "The product's description" }, "serviceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_Service" } }, "componentProductSkuList": { "type": "array", "description": "The list of product component skus", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ComponentProductSku" } }, "configuratorPickChoiceMappingList": { "type": "array", "description": "My Product Style choice mapping", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ConfiguratorPickChoiceMapping" } } }, "xml": { "name": "ComponentProductStyle" } }, "GetConfigurator_ConfigView": { "type": "object", "properties": { "configViewName": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "ConfigView" } }, "GetConfigurator_Configurator": { "required": [ "configuratorPickList" ], "type": "object", "properties": { "configuratorUuid": { "type": "string" }, "event": { "$ref": "#/components/schemas/GetConfigurator_Event" }, "name": { "type": "string" }, "isCustomSize": { "type": "boolean" }, "configViewList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ConfigView" } }, "componentGroupList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ComponentGroup" } }, "prebuiltStyleList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_PrebuiltStyle" } }, "configuratorPickList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ConfiguratorPick" } } }, "xml": { "name": "Configurator" } }, "GetConfigurator_ConfiguratorPick": { "type": "object", "properties": { "configuratorPickUuid": { "type": "string" }, "configuratorPickName": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "pick": { "$ref": "#/components/schemas/GetConfigurator_Pick" }, "pickGroup": { "$ref": "#/components/schemas/GetConfigurator_PickGroup" }, "choiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_Choice" } }, "elementType": { "$ref": "#/components/schemas/GetConfigurator_ElementType" }, "validConfiguratorPickChoice": { "$ref": "#/components/schemas/GetConfigurator_ValidConfiguratorPickChoice" } }, "xml": { "name": "ConfiguratorPick" } }, "GetConfigurator_ConfiguratorPickChoiceMapping": { "type": "object", "properties": { "configuratorPickUuid": { "type": "string" }, "choiceUuid": { "type": "string" } }, "description": "My Product Style choice mapping", "xml": { "name": "ConfiguratorPickChoiceMapping" } }, "GetConfigurator_ElementType": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "ElementType" } }, "GetConfigurator_Event": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "Event" } }, "GetConfigurator_Pick": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "Pick" } }, "GetConfigurator_PickGroup": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "PickGroup" } }, "GetConfigurator_PrebuiltSku": { "type": "object", "properties": { "skuId": { "type": "string" }, "size": { "type": "number" }, "sellingPriceInCents": { "type": "integer", "format": "int32" }, "quantityAvailable": { "type": "integer", "format": "int32" } }, "description": "The prebuilt sku list", "xml": { "name": "PrebuiltSku" } }, "GetConfigurator_PrebuiltStyle": { "type": "object", "properties": { "masterId": { "type": "integer", "format": "int32" }, "styleId": { "type": "string" }, "configuratorPickChoiceMappingList": { "type": "array", "description": "My Product Style choice mapping", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ConfiguratorPickChoiceMapping" } }, "prebuiltSkuList": { "type": "array", "description": "The prebuilt sku list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_PrebuiltSku" } } }, "xml": { "name": "PrebuiltStyle" } }, "GetConfigurator_Service": { "type": "object", "properties": { "settingPriceInCents": { "type": "number", "format": "double" }, "serviceProductId": { "type": "string" } }, "xml": { "name": "Service" } }, "GetConfigurator_ValidChoice": { "type": "object", "properties": { "choiceUuid": { "type": "string" }, "isAvailable": { "type": "boolean" } }, "xml": { "name": "ValidChoice" } }, "GetConfigurator_ValidConfiguratorPickChoice": { "type": "object", "properties": { "configuratorPickUuid": { "type": "string" }, "allChoicesAreValid": { "type": "boolean" }, "validChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ValidChoice" } } }, "xml": { "name": "ValidConfiguratorPickChoice" } }, "ProductConfiguratorService_GetConfiguratorResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "configurator": { "$ref": "#/components/schemas/GetConfigurator_Configurator" } }, "xml": { "name": "getConfiguratorResponse" } }, "GetConfigurator_ConfiguratorAvailabilitySummary": { "type": "object", "properties": { "validChoicesForChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/ValidChoicesForChoice" } }, "productAvailabilityList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/ProductAvailability" } } }, "xml": { "name": "ConfiguratorAvailabilitySummary" } }, "ProductAvailability": { "type": "object", "properties": { "masterId": { "type": "integer", "format": "int32" }, "styleId": { "type": "string" }, "componentProductSkuList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ComponentProductSku" } } } }, "ProductConfiguratorService_GetConfiguratorAvailabilitySummaryResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "configuratorAvailabilitySummary": { "$ref": "#/components/schemas/GetConfigurator_ConfiguratorAvailabilitySummary" } }, "xml": { "name": "getConfiguratorAvailabilitySummaryResponse" } }, "ValidChoicesForChoice": { "type": "object", "properties": { "selectedChoiceUuid": { "type": "string" }, "validConfiguratorPickChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ValidConfiguratorPickChoice" } }, "validPrebuiltPickChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetConfigurator_ValidConfiguratorPickChoice" } } } }, "CreateProductRecipe_CreateProductRecipeResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "productRecipeInfo": { "$ref": "#/components/schemas/CreateProductRecipe_ProductRecipeInfo" } }, "xml": { "name": "createProductRecipeResponse" } }, "CreateProductRecipe_ProductRecipeInfo": { "type": "object", "properties": { "recipeUuid": { "type": "string", "description": "The recipe created attached created sku" } }, "xml": { "name": "ProductRecipeInfo" } }, "CreateProductRecipe_CreateProductRecipeRequest": { "required": [ "configuratorUuid", "mySkuPrice", "selectedProductChoices" ], "type": "object", "properties": { "selectedProductChoices": { "type": "array", "description": "The Selected Product Choices list", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CreateProductRecipe_SelectedProductChoice" } }, "configuratorUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The Id of the configurator" }, "mySkuPrice": { "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The price shown to the customer on the web", "example": 49.99 }, "selectedSizeNo": { "minimum": 0.00, "exclusiveMinimum": false, "type": "number", "description": "The size of the selected product", "example": 8.0 }, "productRecipeType": { "type": "string", "description": "The intended product recipe type of the recipe to be created", "enum": [ "PREBUILT", "USER" ] } }, "xml": { "name": "createProductRecipeRequest" } }, "CreateProductRecipe_SelectedChoice": { "required": [ "selectedChoiceUuid" ], "type": "object", "properties": { "selectedChoiceUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string" } }, "xml": { "name": "selectedChoice" } }, "CreateProductRecipe_SelectedProductChoice": { "required": [ "productId", "selectedChoiceList" ], "type": "object", "properties": { "productId": { "type": "string", "description": "The product Id" }, "componentGroupUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string" }, "componentUuid": { "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string" }, "selectedChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/CreateProductRecipe_SelectedChoice" } } }, "description": "The Selected Product Choices list", "xml": { "name": "selectedProductChoice" } }, "GetProductRecipe_Gemstone": { "type": "object", "properties": { "name": { "type": "string", "description": "The gemstone's name", "example": "ruby" }, "country": { "type": "string", "description": "The country the gemstone is from", "example": "India" }, "treatment": { "type": "string", "description": "The treatment of the gemstone" }, "role": { "type": "string", "description": "The roles of the gemstone", "enum": [ "main", "secondary", "accent", "not_available" ] } }, "description": "The list of gemstones on the product", "xml": { "name": "gemstone" } }, "GetProductRecipe_GetProductRecipeResponse": { "required": [ "productRecipe" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "productRecipe": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipe" } }, "xml": { "name": "getProductRecipeResponse" } }, "GetProductRecipe_InstallmentBillingPlan": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the billing specifics", "example": "3-30-0" }, "numberOfInstallments": { "type": "integer", "description": "The number of Stretch Pay installments", "format": "int32", "example": 3 }, "name": { "type": "string", "description": "The name of the installment billing plan", "example": "3 Pay" } }, "description": "The product's installment billing data", "xml": { "name": "installment-billing-plan" } }, "GetProductRecipe_Pick": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "Pick" } }, "GetProductRecipe_Pricing": { "type": "object", "properties": { "basePrice": { "type": "number", "description": "The base price" }, "comparativeLabel": { "type": "string", "description": "The comparative label", "example": "MSRP, ERV, etc." }, "comparativePrice": { "type": "number", "description": "The comparative price" }, "pricingOfferPrice": { "type": "number", "description": "The pricing offer price" }, "pricingOfferName": { "type": "string", "description": "The pricing offer name" }, "pricingOfferCode": { "type": "string", "description": "The pricing offer code" }, "promoOfferPrice": { "type": "number", "description": "The promo offer price" }, "promoOfferName": { "type": "string", "description": "The promo offer name" }, "promoOfferCode": { "type": "string", "description": "The promo offer code" } }, "description": "The product's pricing data", "xml": { "name": "pricing" } }, "GetProductRecipe_Product": { "type": "object", "properties": { "productId": { "type": "string", "description": "An internal product identifier", "example": "12345" }, "shortDescription": { "type": "string", "description": "The product's short description" }, "longDescription": { "type": "string", "description": "The product's long description" }, "brand": { "type": "string", "description": "The brand associated with the product" }, "subBrand": { "type": "string", "description": "The sub-brand associated with the product" }, "gemstones": { "type": "array", "description": "The list of gemstones on the product", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_Gemstone" } }, "productType": { "type": "string", "description": "The type of the product" }, "productStyles": { "type": "array", "description": "The list of product styles", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_ProductStyle" } }, "subBrandDescription": { "type": "string", "description": "The description of the product's sub-brand" }, "brandDescription": { "type": "string", "description": "The description of the product's brand" }, "romanceDescription": { "type": "string", "description": "The romance description of the product" }, "onAirDescription": { "type": "string", "description": "The on air description of the product" } }, "xml": { "name": "Product" } }, "GetProductRecipe_ProductLabel": { "type": "object", "properties": { "code": { "type": "string", "description": "The code for the product label" }, "name": { "type": "string", "description": "The name of the product label" }, "description": { "type": "string", "description": "The description of the product label" } }, "description": "The product label data", "xml": { "name": "product-label" } }, "GetProductRecipe_ProductRating": { "type": "object", "properties": { "averageRating": { "type": "number", "description": "The product's average rating" }, "numberOfRatings": { "type": "integer", "description": "The product's rating", "format": "int32" } }, "description": "The product's rating", "xml": { "name": "product-rating" } }, "GetProductRecipe_ProductRecipe": { "type": "object", "properties": { "productRecipeType": { "type": "string", "enum": [ "PREBUILT", "USER" ] }, "productRecipeId": { "type": "integer", "format": "int64" }, "skuId": { "type": "string" }, "product": { "$ref": "#/components/schemas/GetProductRecipe_Product" }, "productRecipeUuid": { "type": "string" }, "configuratorUuid": { "type": "string" }, "productRecipeComponentList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipeComponent" } }, "productRecipeSize": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipeSize" }, "productRecipeSetting": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipeSetting" }, "productRecipePickChoiceList": { "type": "array", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipePickChoice" } } }, "xml": { "name": "ProductRecipe" } }, "GetProductRecipe_ProductRecipeChoice": { "type": "object", "properties": { "choiceUuid": { "type": "string" }, "choiceName": { "type": "string" }, "choiceDescription": { "type": "string" }, "configChoiceDescription": { "type": "string" } }, "xml": { "name": "ProductRecipeChoice" } }, "GetProductRecipe_ProductRecipeComponent": { "type": "object", "properties": { "productRecipeComponentUuid": { "type": "string" }, "componentStyleUuid": { "type": "string" }, "imagePath": { "type": "string" }, "componentUuid": { "type": "string" }, "selectedProductId": { "type": "string" } }, "xml": { "name": "ProductRecipeComponent" } }, "GetProductRecipe_ProductRecipePick": { "type": "object", "properties": { "configuratorPickUuid": { "type": "string" }, "configuratorPickName": { "type": "string" }, "pick": { "$ref": "#/components/schemas/GetProductRecipe_Pick" }, "displayOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProductRecipePick" } }, "GetProductRecipe_ProductRecipePickChoice": { "type": "object", "properties": { "productRecipeChoice": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipeChoice" }, "productRecipePick": { "$ref": "#/components/schemas/GetProductRecipe_ProductRecipePick" } }, "xml": { "name": "ProductRecipePickChoice" } }, "GetProductRecipe_ProductRecipeSetting": { "type": "object", "properties": { "needsSettingSku": { "type": "boolean" }, "settingSku": { "type": "string" } }, "xml": { "name": "ProductRecipeSetting" } }, "GetProductRecipe_ProductRecipeSize": { "type": "object", "properties": { "sizeNo": { "type": "number" }, "isCustomSize": { "type": "boolean" }, "sizingSku": { "type": "string" } }, "xml": { "name": "ProductRecipeSize" } }, "GetProductRecipe_ProductSku": { "type": "object", "properties": { "skuId": { "type": "string", "description": "An internal product sku identifier", "example": "12345" }, "size": { "type": "number", "description": "The product sku's size" }, "warrantySku": { "type": "string", "description": "The eligible Warranty SKU" } }, "description": "The list of product skus" }, "GetProductRecipe_ProductStyle": { "type": "object", "properties": { "masterId": { "type": "integer", "description": "An internal product style identifier", "format": "int32", "example": 12345 }, "styleId": { "type": "string", "description": "The product style external id (it is master sku in the old product model taxonomy)", "example": "DQK998Y" }, "productRating": { "$ref": "#/components/schemas/GetProductRecipe_ProductRating" }, "shortDescription": { "type": "string", "description": "The product's short description" }, "longDescription": { "type": "string", "description": "The product's long description" }, "imageUrls": { "type": "array", "description": "The product's image urls", "xml": { "wrapped": true }, "items": { "type": "string", "description": "The product's image urls", "xml": { "name": "imageUrl" } } }, "productStyleMediaList": { "type": "array", "description": "The product's media", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_ProductStyleMedia" } }, "productSkus": { "type": "array", "description": "The list of product skus", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_ProductSku" } }, "romanceDescription": { "type": "string", "description": "The romance description of the product's brand" }, "appraisalAvailable": { "type": "boolean", "description": "Is appraisal available?" }, "warrantyAvailable": { "type": "boolean", "description": "Is warranty available?" }, "pricing": { "$ref": "#/components/schemas/GetProductRecipe_Pricing" }, "installmentBillingPlans": { "type": "array", "description": "The product's installment billing data", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_InstallmentBillingPlan" } }, "productLabels": { "type": "array", "description": "The product label data", "xml": { "wrapped": true }, "items": { "$ref": "#/components/schemas/GetProductRecipe_ProductLabel" } }, "onAirDescription": { "type": "string", "description": "The on air description of the product" } }, "description": "The list of product styles" }, "GetProductRecipe_ProductStyleMedia": { "type": "object", "properties": { "mediaUrl": { "type": "string", "description": "The product's media url" }, "thumbnailUrl": { "type": "string", "description": "The product's thumbnail url" } }, "description": "The product's media", "xml": { "name": "product-style-media" } }, "ReservationService_CreateReservationResponse": { "required": [ "reservationId" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "reservationId": { "type": "string", "description": "The reservation identifier.", "example": "283286618" } }, "xml": { "name": "createReservationResponse" } }, "ReservationService_CreateReservationRequest": { "required": [ "productId", "quantityRequested", "timeToLiveInMinutes" ], "type": "object", "properties": { "timeToLiveInMinutes": { "maximum": 120, "minimum": 1, "type": "integer", "description": "Time to live of reservation in minutes.", "format": "int32", "example": 5 }, "productId": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The product id (old product sku id)", "example": "DQK998-7" }, "quantityRequested": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Quantity requested for reservation.", "format": "int32", "example": 10 } }, "xml": { "name": "createReservationRequest" } }, "ReservationService_GetReservationResponse": { "required": [ "reservation" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "reservation": { "$ref": "#/components/schemas/ReservationService_Reservation" } }, "xml": { "name": "getReservationResponse" } }, "ReservationService_Reservation": { "required": [ "productId", "quantityReserved", "reservationDateTime", "reservationId" ], "type": "object", "properties": { "reservationId": { "type": "string", "description": "The reservation identifier.", "example": "283286618" }, "quantityReserved": { "type": "integer", "description": "reservationId", "format": "int32", "example": 5 }, "productId": { "type": "string", "description": "The product id (old product sku id)", "example": "DQK998-7" }, "reservationDateTime": { "type": "string", "description": "The product reservation expiration date.", "format": "date-time", "example": "2001-07-04T12:08:56.235-07:00" } }, "description": "Reservation resource representation." }, "ReservationService_UpdateReservationRequest": { "required": [ "timeToLiveInMinutes" ], "type": "object", "properties": { "timeToLiveInMinutes": { "maximum": 120, "minimum": 1, "type": "integer", "description": "Time to live of reservation in minutes.", "format": "int32", "example": 5 } }, "xml": { "name": "updateReservationRequest" } }, "SalesTaxService_SalesTax": { "required": [ "appliesToAppraisal", "appliesToProduct", "appliesToShipping", "appliesToSizing", "appliesToWarranty", "salesTaxPercentage" ], "type": "object", "properties": { "appliesToAppraisal": { "type": "boolean", "description": "Indicates if tax percentage applies to appraisal.", "example": true }, "appliesToProduct": { "type": "boolean", "description": "Indicates if tax percentage applies to product.", "example": true }, "appliesToShipping": { "type": "boolean", "description": "Indicates if tax percentage applies to shipping.", "example": true }, "appliesToSizing": { "type": "boolean", "description": "Indicates if tax percentage applies to shipping.", "example": true }, "appliesToWarranty": { "type": "boolean", "description": "Indicates if tax percentage applies to warranty.", "example": true }, "salesTaxPercentage": { "type": "number", "description": "Represents the tax percentage to be applied.", "format": "float", "example": 9.25 } }, "description": "Sales tax service resource representation." }, "SalesTaxService_SalesTaxResponse": { "required": [ "salesTax" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "salesTax": { "$ref": "#/components/schemas/SalesTaxService_SalesTax" } }, "xml": { "name": "salesTaxResponse" } }, "UserService_CreateUserResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "userId": { "type": "string", "description": "The user's JTV enterprise unique universal id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" } }, "xml": { "name": "createUserResponse" } }, "UserService_UpdateUserResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 } }, "xml": { "name": "updateUserResponse" } }, "UpdateServiceUser": { "required": [ "firstName", "lastName", "userName" ], "type": "object", "properties": { "userName": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "User email address", "example": "susan.smith@gmail.com" }, "firstName": { "type": "string", "description": "User first name", "example": "Susan" }, "lastName": { "type": "string", "description": "User last name", "example": "Smith" } }, "description": "Update user resource representation.", "xml": { "name": "UpdateUser" } }, "UserService_UpdateUserRequest": { "required": [ "updateUser" ], "type": "object", "properties": { "updateUser": { "$ref": "#/components/schemas/UpdateServiceUser" } }, "xml": { "name": "updateUserRequest" } }, "GetServiceUser": { "required": [ "firstName", "lastName", "userId", "userName" ], "type": "object", "properties": { "userName": { "maxLength": 45, "minLength": 1, "pattern": "^[\\p{ASCII}]*$", "type": "string", "description": "User email address", "example": "susan.smith@gmail.com" }, "userId": { "maxLength": 36, "minLength": 36, "pattern": "^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$", "type": "string", "description": "The user's JTV enterprise unique universal id", "example": "889e6036-34ce-494d-b7da-d06b213583d6" }, "firstName": { "type": "string", "description": "User first name", "example": "Susan" }, "lastName": { "type": "string", "description": "User last name", "example": "Smith" } }, "description": "Get user resource representation.", "xml": { "name": "GetUser" } }, "UserService_GetUserResponse": { "required": [ "user" ], "type": "object", "properties": { "conversationId": { "type": "string", "description": "The client provided conversation id.", "example": "CV#-WEBSITE" }, "transactionId": { "type": "string", "description": "The unique transaction id.", "example": "TX#-61287b9f-05e0-4095" }, "transactionMills": { "type": "integer", "description": "The milliseconds required to process this transaction.", "format": "int64", "example": 156 }, "user": { "$ref": "#/components/schemas/GetServiceUser" } }, "xml": { "name": "userResponse" } }, "UserService_TieUserToPartnerAssociateAccountRequest": { "required": [ "inviteToken" ], "type": "object", "properties": { "inviteToken": { "type": "string", "description": "The invite token." } }, "xml": { "name": "tieUserToPartnerAssociateAccountRequest" } } }, "securitySchemes": { "JWT Bearer Token": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "https://account.jtv.com": { "type": "oauth2", "description": "PROD", "in": "header", "flows": { "authorizationCode": { "authorizationUrl": "https://account.jtv.com/auth/realms/jtv/protocol/openid-connect/auth", "tokenUrl": "https://account.jtv.com/auth/realms/jtv/protocol/openid-connect/token", "scopes": { "openid": "", "profile": "", "phone": "" } } } }, "https://account-uat.jtv.com": { "type": "oauth2", "description": "UAT", "in": "header", "flows": { "authorizationCode": { "authorizationUrl": "https://account-uat.jtv.com/auth/realms/jtv/protocol/openid-connect/auth", "tokenUrl": "https://account-uat.jtv.com/auth/realms/jtv/protocol/openid-connect/token", "scopes": { "openid": "", "profile": "", "phone": "" } } } }, "http://psapdl38.jewelry.acn:8090": { "type": "oauth2", "description": "DEV", "in": "header", "flows": { "authorizationCode": { "authorizationUrl": "http://psapdl38.jewelry.acn:8090/auth/realms/jtv/protocol/openid-connect/auth", "tokenUrl": "https://account-dev.jtv.com/auth/realms/jtv/protocol/openid-connect/token", "refreshUrl": "https://account-dev.jtv.com/auth/realms/jtv/protocol/openid-connect/token", "scopes": { "openid": "", "profile": "", "phone": "" } } } }, "https://account-qa.jtv.com": { "type": "oauth2", "description": "QA", "in": "header", "flows": { "authorizationCode": { "authorizationUrl": "https://account-qa.jtv.com/auth/realms/jtv/protocol/openid-connect/auth", "tokenUrl": "https://account-qa.jtv.com/auth/realms/jtv/protocol/openid-connect/token", "scopes": { "openid": "", "profile": "", "phone": "" } } } } } } }