openapi: 3.0.0 info: title: Distributor-SPJ-Rebate version: '2.1' description: Distributor-SPJ-Rebate API will give distributors the ability to retrieve SPJ rebate information seamlessly in their ecosystem. This is available only for NAM distributors using SE Advantage application for quotation management. contact: name: Contact Us url: https://se.com email: distributorapiportal.global@se.com paths: /quotelines/{quote-number}: parameters: - schema: type: string example: Q-203645 name: quote-number in: path required: true example: Q-203645 description: SE Advantage valid Q number for your distributor account get: summary: Get Quote Lines tags: [] responses: '200': description: User Found content: application/json: schema: type: object properties: quoteHeader: $ref: '#/components/schemas/QuoteHeader' quoteLines: type: array items: $ref: '#/components/schemas/QuoteLine' examples: example-1: value: quoteHeader: authorizedNetPrice: 2700 billToAccountNumber: '38356' createdBy: David Cardamone quoteExpirationDate: '2020-05-07' rebateExpirationDate: '2020-05-08' rebateOrderAcknowledged: true customerNumber: '9722768728' customerName: TLC ELECTRIC, LLC proposalCity: DALLAS proposalName: SECTION STACK proposalState: null quoteName: SECTION STACK quoteNumber: Q-1599877 quoteStatus: Finalized totalAmount: 0 quoteLines: - UPCCode: '785901432678' authorizedUnitPrice: 10.31 catalogNumber: PKOGTA2 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 11.69 distributorSellNetPrice: 10.3104 extendedPurchaserProfilePrice: 22 extendedRebateAmount: 0 groupName: null itemCategory: '00058' itemDescription: EQUIP GRD ASSY 240V + 600V 100-200 itemDesignation: null lineDisplayNumber: 42409301 profileUnitNetPrice: 22 totalOrderQuantity: 1 unitListPrice: 55 - UPCCode: '785901272540' authorizedUnitPrice: 966.35 catalogNumber: EXN30T3H controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 178.55 distributorSellNetPrice: 966.3492 extendedPurchaserProfilePrice: 1144.9 extendedRebateAmount: 0 groupName: null itemCategory: '16256' itemDescription: TRANSFORMER DRY TYPE 30KVA 480D208Y AL-1 itemDesignation: null lineDisplayNumber: 42409082 profileUnitNetPrice: 1144.9 totalOrderQuantity: 1 unitListPrice: 2657 - UPCCode: '785901482338' authorizedUnitPrice: 332.7 catalogNumber: H364N controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 134.55 distributorSellNetPrice: 332.6992 extendedPurchaserProfilePrice: 467.25 extendedRebateAmount: 0 groupName: null itemCategory: '00008' itemDescription: SWITCH FUSIBLE HD 600V 200A 3P NEUTRAL itemDesignation: null lineDisplayNumber: 42409006 profileUnitNetPrice: 467.25 totalOrderQuantity: 1 unitListPrice: 1869 - UPCCode: '785901507864' authorizedUnitPrice: 165.84 catalogNumber: NQ442L2 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 826.03 distributorSellNetPrice: 165.838 extendedPurchaserProfilePrice: 991.87 extendedRebateAmount: 0 groupName: null itemCategory: '09151' itemDescription: PNLBD INT NQ 225A MLO 42 CKT 3P AL itemDesignation: PANEL L lineDisplayNumber: 42410720 profileUnitNetPrice: 991.87 totalOrderQuantity: 1 unitListPrice: 1476 - UPCCode: '785901156819' authorizedUnitPrice: 4.36 catalogNumber: PK27GTA controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 13.1 distributorSellNetPrice: 4.356 extendedPurchaserProfilePrice: 17.46 extendedRebateAmount: 0 groupName: null itemCategory: '00102' itemDescription: LOAD CENTER EQUIPMENT GROUND BAR ASSY itemDesignation: PANEL L lineDisplayNumber: 42410721 profileUnitNetPrice: 17.46 totalOrderQuantity: 1 unitListPrice: 33.8 - UPCCode: '785901484288' authorizedUnitPrice: 7.54 catalogNumber: NQFP15 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 2 creditAmount: 76.32 distributorSellNetPrice: 15.0829 extendedPurchaserProfilePrice: 91.39 extendedRebateAmount: 0 groupName: null itemCategory: '08332' itemDescription: NQ FILLER PLATE KIT (15 PER PKG) itemDesignation: PANEL L lineDisplayNumber: 42410722 profileUnitNetPrice: 45.7 totalOrderQuantity: 2 unitListPrice: 68 - UPCCode: '785901871569' authorizedUnitPrice: 278.08 catalogNumber: NF442L2 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 1346.82 distributorSellNetPrice: 278.0771 extendedPurchaserProfilePrice: 1624.9 extendedRebateAmount: 0 groupName: null itemCategory: '08350' itemDescription: PANELBOARD INTERIOR NF 250A MLO 42CKT 3P itemDesignation: PANEL H lineDisplayNumber: 42410407 profileUnitNetPrice: 1624.9 totalOrderQuantity: 1 unitListPrice: 2418 - UPCCode: '785901156819' authorizedUnitPrice: 4.36 catalogNumber: PK27GTA controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 13.1 distributorSellNetPrice: 4.356 extendedPurchaserProfilePrice: 17.46 extendedRebateAmount: 0 groupName: null itemCategory: '00102' itemDescription: LOAD CENTER EQUIPMENT GROUND BAR ASSY itemDesignation: PANEL H lineDisplayNumber: 42410408 profileUnitNetPrice: 17.46 totalOrderQuantity: 1 unitListPrice: 33.8 - UPCCode: '785901699736' authorizedUnitPrice: 12.53 catalogNumber: NFFP15 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 63.41 distributorSellNetPrice: 12.5321 extendedPurchaserProfilePrice: 75.94 extendedRebateAmount: 0 groupName: null itemCategory: '08338' itemDescription: NF FILLER PLATE KIT (15 PER PKG) itemDesignation: PANEL H lineDisplayNumber: 42410409 profileUnitNetPrice: 75.94 totalOrderQuantity: 1 unitListPrice: 113 - UPCCode: '785901875284' authorizedUnitPrice: 76.13 catalogNumber: EDB34040 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 329.95 distributorSellNetPrice: 76.1268 extendedPurchaserProfilePrice: 406.08 extendedRebateAmount: 0 groupName: null itemCategory: '00931' itemDescription: MINIATURE CIRCUIT BREAKER 480Y/277V 40A itemDesignation: PANEL H lineDisplayNumber: 42410410 profileUnitNetPrice: 406.08 totalOrderQuantity: 1 unitListPrice: 669 - UPCCode: '785901875246' authorizedUnitPrice: 76.13 catalogNumber: EDB34020 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 3 creditAmount: 989.85 distributorSellNetPrice: 228.3805 extendedPurchaserProfilePrice: 1218.25 extendedRebateAmount: 0 groupName: null itemCategory: '00931' itemDescription: MINIATURE CIRCUIT BREAKER 480Y/277V 20A itemDesignation: PANEL H lineDisplayNumber: 42410411 profileUnitNetPrice: 406.08 totalOrderQuantity: 3 unitListPrice: 669 - UPCCode: '785901878902' authorizedUnitPrice: 17.07 catalogNumber: EDB14020 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 6 creditAmount: 443.88 distributorSellNetPrice: 102.4128 extendedPurchaserProfilePrice: 546.3 extendedRebateAmount: 0 groupName: null itemCategory: '00931' itemDescription: MINIATURE CIRCUIT BREAKER 277V 20A itemDesignation: PANEL H lineDisplayNumber: 42410412 profileUnitNetPrice: 91.05 totalOrderQuantity: 6 unitListPrice: 150 - UPCCode: '785901378907' authorizedUnitPrice: 15.5 catalogNumber: MH44 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 0 distributorSellNetPrice: 15.4985 extendedPurchaserProfilePrice: 15.5 extendedRebateAmount: 0 groupName: null itemCategory: '07969' itemDescription: PANELBOARD ENCLOSURE/BOX itemDesignation: PANEL H lineDisplayNumber: 42410413 profileUnitNetPrice: 15.5 totalOrderQuantity: 1 unitListPrice: 113 - UPCCode: '785901798880' authorizedUnitPrice: 75.83 catalogNumber: NC44S controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 369.71 distributorSellNetPrice: 75.8283 extendedPurchaserProfilePrice: 445.54 extendedRebateAmount: 0 groupName: null itemCategory: '08352' itemDescription: PANELBOARD COVER/TRIM NF TYPE 1 S 44H itemDesignation: PANEL H lineDisplayNumber: 42410414 profileUnitNetPrice: 445.54 totalOrderQuantity: 1 unitListPrice: 663 - UPCCode: '785901666103' authorizedUnitPrice: 87.64 catalogNumber: NQMB2Q controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 436.52 distributorSellNetPrice: 87.638 extendedPurchaserProfilePrice: 524.16 extendedRebateAmount: 0 groupName: null itemCategory: '09151' itemDescription: PNLBD NQ MCB KIT FOR 225A MAX Q FRAME itemDesignation: PANEL L lineDisplayNumber: 42410723 profileUnitNetPrice: 524.16 totalOrderQuantity: 1 unitListPrice: 780 - UPCCode: '785901416906' authorizedUnitPrice: 10.22 catalogNumber: QOB230 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 43.8 distributorSellNetPrice: 10.2171 extendedPurchaserProfilePrice: 54.02 extendedRebateAmount: 0 groupName: null itemCategory: '00015' itemDescription: MINIATURE CIRCUIT BREAKER 120/240V 30A itemDesignation: PANEL L lineDisplayNumber: 42410724 profileUnitNetPrice: 54.02 totalOrderQuantity: 1 unitListPrice: 89 - UPCCode: '785901416722' authorizedUnitPrice: 4.57 catalogNumber: QOB120 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 7 creditAmount: 137.13 distributorSellNetPrice: 31.9831 extendedPurchaserProfilePrice: 169.11 extendedRebateAmount: 0 groupName: null itemCategory: '00015' itemDescription: MINIATURE CIRCUIT BREAKER 120/240V 20A itemDesignation: PANEL L lineDisplayNumber: 42410725 profileUnitNetPrice: 24.16 totalOrderQuantity: 7 unitListPrice: 39.8 - UPCCode: '785901702870' authorizedUnitPrice: 183.44 catalogNumber: QBL32100 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 574.1 distributorSellNetPrice: 183.4384 extendedPurchaserProfilePrice: 757.54 extendedRebateAmount: 0 groupName: null itemCategory: '00023' itemDescription: MOLDED CASE CIRCUIT BREAKER 240V 100A itemDesignation: PANEL L lineDisplayNumber: 42410726 profileUnitNetPrice: 757.54 totalOrderQuantity: 1 unitListPrice: 1248 - UPCCode: null authorizedUnitPrice: null catalogNumber: null controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 0.05 distributorSellNetPrice: null extendedPurchaserProfilePrice: null extendedRebateAmount: null groupName: null itemCategory: null itemDescription: null itemDesignation: null lineDisplayNumber: null profileUnitNetPrice: null totalOrderQuantity: null unitListPrice: null - UPCCode: '785901378914' authorizedUnitPrice: 15.5 catalogNumber: MH50 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 0 distributorSellNetPrice: 15.4985 extendedPurchaserProfilePrice: 15.5 extendedRebateAmount: 0 groupName: null itemCategory: '07969' itemDescription: PANELBOARD ENCLOSURE/BOX TYPE 1 50H 20W itemDesignation: PANEL L lineDisplayNumber: 42410727 profileUnitNetPrice: 15.5 totalOrderQuantity: 1 unitListPrice: 113 - UPCCode: '785901798903' authorizedUnitPrice: 83.38 catalogNumber: NC50S controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 406.51 distributorSellNetPrice: 83.3768 extendedPurchaserProfilePrice: 489.89 extendedRebateAmount: 0 groupName: null itemCategory: '08352' itemDescription: PANELBOARD COVER/TRIM NF TYPE 1 S 50H itemDesignation: PANEL L lineDisplayNumber: 42410728 profileUnitNetPrice: 489.89 totalOrderQuantity: 1 unitListPrice: 729 '400': $ref: '#/components/responses/Common_Oas3_400' '401': $ref: '#/components/responses/Common_Oas3_401' '403': $ref: '#/components/responses/Common_Oas3_403' '404': $ref: '#/components/responses/Common_Oas3_404' '429': $ref: '#/components/responses/Common_Oas3_429' '500': $ref: '#/components/responses/Common_Oas3_500' operationId: get-quotelines-quote-number description: |- This API provides the information about small project rebates: a kind of "reimbursement" for using the distributors' local stocks when working with smaller companies instead of ordering from Schneider. As part of response, only line items with associated rebates will be listed. Non-rebate related line items on the order will not appear. If you need the order line items, refer Order Status API’s. components: schemas: QuoteHeader: description: '' type: object x-examples: example-1: authorizedNetPrice: 2700 billToAccountNumber: '38356' createdBy: David Cardamone quoteExpirationDate: '2020-05-07' rebateExpirationDate: '2020-05-08' rebateOrderAcknowledged: true customerNumber: '9722768728' customerName: TLC ELECTRIC, LLC proposalCity: DALLAS proposalName: SECTION STACK proposalState: null quoteName: SECTION STACK quoteNumber: Q-1599877 quoteStatus: Finalized totalAmount: 0 value: authorizedNetPrice: 2700 billToAccountNumber: '38356' createdBy: David Cardamone quoteExpirationDate: '2020-05-07' rebateExpirationDate: '2020-05-08' rebateOrderAcknowledged: true customerNumber: '9722768728' customerName: TLC ELECTRIC, LLC proposalCity: DALLAS proposalName: SECTION STACK proposalState: null quoteName: SECTION STACK quoteNumber: Q-1599877 quoteStatus: Finalized totalAmount: 0 properties: authorizedNetPrice: type: number description: Authorized Net Price for the project. billToAccountNumber: type: string minLength: 1 description: | The SE 5 digit account number ref for a specific locaton. createdBy: type: string minLength: 1 description: | Who created the quote. quoteExpirationDate: type: string minLength: 1 description: | When the Qutoe Expires (date) rebateExpirationDate: type: string minLength: 1 description: Date when the Rebate will expire. rebateOrderAcknowledged: type: boolean description: True/False that the Rebate has been acknowledged. customerNumber: type: string minLength: 1 description: | SE refernce to the customer number (typically 10 digit) customerName: type: string minLength: 1 description: The Customer Name proposalCity: type: string minLength: 1 description: City where job is to be installed. proposalName: type: string minLength: 1 description: | The name of the proposal. proposalState: type: string description: Proposal State. nullable: true quoteName: type: string minLength: 1 description: Name for the Quote. A proposal for example might have one or more quotes with unique names. quoteNumber: type: string minLength: 1 description: The Quote Number reference. quoteStatus: type: string minLength: 1 description: Quote status, like Pending, Closed, Authorized totalAmount: type: number description: Total Amount for the quote (all the line items). required: - authorizedNetPrice - billToAccountNumber - createdBy - quoteExpirationDate - rebateExpirationDate - rebateOrderAcknowledged - customerNumber - customerName - proposalCity - proposalName - quoteName - quoteNumber - quoteStatus - totalAmount QuoteLine: description: '' type: object x-examples: example-1: UPCCode: '785901432678' authorizedUnitPrice: 10.31 catalogNumber: PKOGTA2 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 11.69 distributorSellNetPrice: 10.3104 extendedPurchaserProfilePrice: 22 extendedRebateAmount: 0 groupName: null itemCategory: '00058' itemDescription: EQUIP GRD ASSY 240V + 600V 100-200 itemDesignation: null lineDisplayNumber: 42409301 profileUnitNetPrice: 22 totalOrderQuantity: 1 unitListPrice: 55 value: UPCCode: '785901432678' authorizedUnitPrice: 10.31 catalogNumber: PKOGTA2 controlNumberForClaim: '6556769' createdDate: '2020-03-11' rebateName: SECTION STACK invoiceNumber: '18754389' invoiceDate: '2020-04-08' submitDate: '2020-04-08' rebatedQuantity: 1 creditAmount: 11.69 distributorSellNetPrice: 10.3104 extendedPurchaserProfilePrice: 22 extendedRebateAmount: 0 groupName: null itemCategory: '00058' itemDescription: EQUIP GRD ASSY 240V + 600V 100-200 itemDesignation: null lineDisplayNumber: 42409301 profileUnitNetPrice: 22 totalOrderQuantity: 1 unitListPrice: 55 title: '' properties: UPCCode: type: string minLength: 1 description: UPC code which is different than the SE catalog number. nullable: true authorizedUnitPrice: type: number description: | The distributor's authorize price per unit. nullable: true catalogNumber: type: string minLength: 1 description: The SE Catalog Commercial Reference Number. This is not the UPC code. nullable: true controlNumberForClaim: type: string minLength: 1 description: '***This is the key field for this API. This is the rebate claim number...normally the main reason to call the api.' createdDate: type: string minLength: 1 description: | Date the qutoe agreement was made. rebateName: type: string minLength: 1 description: | Name created in SEA to identify the rebate. invoiceNumber: type: string minLength: 1 description: | Invoice number supplied by the distributor into SEA. invoiceDate: type: string minLength: 1 description: | The date the invoice was obtained. submitDate: type: string minLength: 1 description: | The date the rebate request was created/requested. rebatedQuantity: type: number description: | Quantity of iems for this line reference. creditAmount: type: number distributorSellNetPrice: type: number nullable: true extendedPurchaserProfilePrice: type: number nullable: true extendedRebateAmount: type: number nullable: true groupName: type: string description: | Used to create line item groups. For example floor 1, foor 2, etc. nullable: true itemCategory: type: string minLength: 1 description: Category fpr pricing. nullable: true itemDescription: type: string minLength: 1 description: | Description for the catalog number or edngineered product ref. nullable: true itemDesignation: type: string description: | What the customer calls or describes the item as. For example, Conference Room #1 Switch. nullable: true lineDisplayNumber: type: number description: | Number used to display reference with a list of items. nullable: true profileUnitNetPrice: type: number description: | Standard profile price for a unit (also ref Category field classification) nullable: true totalOrderQuantity: type: number description: | The per unit Net Profile price. (seeing the example response is usually helpful to review the various price levels) nullable: true unitListPrice: type: number description: | The List Prce per unit. Shoud match up with SE web page list price. nullable: true required: - UPCCode - authorizedUnitPrice - catalogNumber - controlNumberForClaim - createdDate - rebateName - invoiceNumber - invoiceDate - submitDate - rebatedQuantity - creditAmount - distributorSellNetPrice - extendedPurchaserProfilePrice - extendedRebateAmount - itemCategory - itemDescription - lineDisplayNumber - profileUnitNetPrice - totalOrderQuantity - unitListPrice ErrorResponse: type: object title: Error Response - OAS3 description: Error response returned to the consumer when an HTTP error status has occurred. properties: code: type: string example: MISSING_FIELD or 12345 description: |- Service-defined error code which may be numeric or a string. Errors detected by the APIM platform result in the following codes. BAD_REQUEST (for 400) UNAUTHORIZED (for 401) FORBIDDEN (for 403) NOT_FOUND (for 404) GONE (for 410) PRECONDITION_FAILED (for 412) TOO_MANY_REQUESTS (for 429) INTERNAL_SERVER_ERROR (for 500) NOT_IMPLEMENTED (for 501) Any specific service validation errors would replace BAD_REQUEST. userMessage: type: string example: Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI. description: Human-readable general description of the error. developerMessage: type: string description: Optional human-readable description of the error details. example: 'Required field is missing: productSku' moreInfo: type: string description: Optional error details or link to error documentation, which has more information about the error. example: https://example.com/product-master/v1/error/12345 required: - code - userMessage securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: refreshUrl: '' scopes: {} tokenUrl: /token description: OAuth2 API access token. responses: Common_Oas3_400: description: Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: BAD_REQUEST userMessage: Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI. developerMessage: Request content is malformed or exceeded structural limits moreInfo: https://example.com/error/123 Common_Oas3_401: description: The client is not authorized to perform this request because its identity has not yet been established, or the token is invalid or has expired. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: UNAUTHORIZED userMessage: The client is not authorized to perform this request because its identity has not yet been established, or the token is invalid or has expired. developerMessage: Invalid Access Token moreInfo: https://example.com/error/123 Common_Oas3_403: description: The client does not have permission to perform the requested action e.g. POST or DELETE. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: FORBIDDEN userMessage: The client does not have permission to perform the requested action e.g. POST or DELETE. developerMessage: Http verb DELETE is not supported for path suffix /installed-products/track moreInfo: https://example.com/error/123 Common_Oas3_404: description: Requested resource does not exist on the server. It is assumed that the URI is valid for this type of resource. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: NOT_FOUND userMessage: Requested resource does not exist on the server. It is assumed that the URI is valid for this type of resource. developerMessage: Records not found moreInfo: https://example.com/error/123 Common_Oas3_429: description: Number of requests has exceeded the client's rate limits. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: TOO_MANY_REQUESTS userMessage: Number of requests has exceeded the client’s rate limits. developerMessage: Spike arrest violation moreInfo: https://example.com/error/123 Common_Oas3_500: description: Requested operation encountered an unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: INTERNAL_SERVER_ERROR userMessage: Requested operation encountered an unexpected server error. developerMessage: Target service is unavailable, please try again later. moreInfo: https://example.com/error/123 servers: - url: ' https://api.qa.se.com/v2/customer-order/rebate/spj-rebate' description: QA/test environment - url: ' https://api.se.com/v2/customer-order/rebate/spj-rebate' description: Production server security: - OAuth2: []