openapi: 3.0.0 info: title: Distributor Quote version: '1.0' description: |- This is a read only service allowing Distributors to retrieve quote-lines based on quotes associated with their accounts. These quotes will generally be in the process of conversion from Quote to becoming an Order. Specifically, SE Distributors are tapping into these services to help them bridge processing steps from Schneider to their internal systems. Without process automation via API, Schneider Distributors need to manually act as the bridge for data between systems. In order to achieve efficient process and get rid of error-prone system, this API is designed. This particular API is considered as the first step while initiating a series of transactions between the Distributor and Schneider. 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: OK 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: quoteId: a1F1K0000071Fm9UAE quoteName: SECTION STACK quoteNumber: Q-1599877 quoteStatus: Finalized authorizedTomv: 2700 billToAccountNumber: '38356' createdBy: David Cardamone createdDate: 2020-03-11T20:36:15.000+0000 billToAccountName: MAYER ELECTRIC SUP CO INC rebateExpirationDate: '2020-05-08' rebateOrderAcknowledged: true proposalName: SECTION STACK orderTomv: 0 totalRebateAmount: 6395.06 quoteLines: - quoteLineId: a1B1K00000IidkBUAR totalOrderQuantity: 1 catalogNumber: H364N itemDesignation: null itemDescription: SWITCH FUSIBLE HD 600V 200A 3P NEUTRAL profileUnitNetPrice: 467.25 itemCategory: '00008' lineDisplayNumber: '42409006' spjRebate: true unitListPrice: 1869 extendedPurchaserProfilePrice: 467.25 groupName: null distributorSellNetPrice: 332.7 authorizedSellExtPrice: 332.7 UPCCode: '785901482338' authorizedUnitPrice: 332.7 sortSequenceGrid: 1 productSelectorMaterialSequenceID: null - quoteLineId: a1B1K00000Iidh5UAB totalOrderQuantity: 1 catalogNumber: EXN30T3H itemDesignation: null itemDescription: TRANSFORMER DRY TYPE 30KVA 480D208Y AL-1 profileUnitNetPrice: 1144.91 itemCategory: '16256' lineDisplayNumber: '42409082' spjRebate: true unitListPrice: 2657 extendedPurchaserProfilePrice: 1144.9 groupName: null distributorSellNetPrice: 966.35 authorizedSellExtPrice: 966.35 UPCCode: '785901272540' authorizedUnitPrice: 966.35 sortSequenceGrid: 2 productSelectorMaterialSequenceID: null - quoteLineId: a1B1K00000IiYh8UAF totalOrderQuantity: 1 catalogNumber: PKOGTA2 itemDesignation: null itemDescription: EQUIP GRD ASSY 240V + 600V 100-200 profileUnitNetPrice: 22 itemCategory: '00058' lineDisplayNumber: '42409301' spjRebate: true unitListPrice: 55 extendedPurchaserProfilePrice: 22 groupName: null distributorSellNetPrice: 10.32 authorizedSellExtPrice: 10.32 UPCCode: '785901432678' authorizedUnitPrice: 10.32 sortSequenceGrid: 3 productSelectorMaterialSequenceID: null - quoteLineId: a1B1K00000IieBNUAZ totalOrderQuantity: 1 catalogNumber: NF442L2 itemDesignation: PANEL H itemDescription: PANELBOARD INTERIOR NF 250A MLO 42CKT 3P profileUnitNetPrice: 1624.9 itemCategory: '08350' lineDisplayNumber: '42410407' spjRebate: true unitListPrice: 2418 extendedPurchaserProfilePrice: 1624.9 groupName: null distributorSellNetPrice: 278.08 authorizedSellExtPrice: 278.08 UPCCode: '785901871569' authorizedUnitPrice: 278.08 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '1' - quoteLineId: a1B1K00000IieBOUAZ totalOrderQuantity: 1 catalogNumber: PK27GTA itemDesignation: PANEL H itemDescription: LOAD CENTER EQUIPMENT GROUND BAR ASSY profileUnitNetPrice: 17.46 itemCategory: '00102' lineDisplayNumber: '42410408' spjRebate: true unitListPrice: 33.8 extendedPurchaserProfilePrice: 17.46 groupName: null distributorSellNetPrice: 4.36 authorizedSellExtPrice: 4.36 UPCCode: '785901156819' authorizedUnitPrice: 4.36 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '2' - quoteLineId: a1B1K00000IieBPUAZ totalOrderQuantity: 1 catalogNumber: NFFP15 itemDesignation: PANEL H itemDescription: NF FILLER PLATE KIT (15 PER PKG) profileUnitNetPrice: 75.94 itemCategory: '08338' lineDisplayNumber: '42410409' spjRebate: true unitListPrice: 113 extendedPurchaserProfilePrice: 75.94 groupName: null distributorSellNetPrice: 12.54 authorizedSellExtPrice: 12.54 UPCCode: '785901699736' authorizedUnitPrice: 12.54 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '3' - quoteLineId: a1B1K00000IieBQUAZ totalOrderQuantity: 1 catalogNumber: EDB34040 itemDesignation: PANEL H itemDescription: MINIATURE CIRCUIT BREAKER 480Y/277V 40A profileUnitNetPrice: 406.09 itemCategory: '00931' lineDisplayNumber: '42410410' spjRebate: true unitListPrice: 669 extendedPurchaserProfilePrice: 406.08 groupName: null distributorSellNetPrice: 76.13 authorizedSellExtPrice: 76.13 UPCCode: '785901875284' authorizedUnitPrice: 76.13 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '4' - quoteLineId: a1B1K00000IieBRUAZ totalOrderQuantity: 3 catalogNumber: EDB34020 itemDesignation: PANEL H itemDescription: MINIATURE CIRCUIT BREAKER 480Y/277V 20A profileUnitNetPrice: 406.09 itemCategory: '00931' lineDisplayNumber: '42410411' spjRebate: true unitListPrice: 669 extendedPurchaserProfilePrice: 1218.25 groupName: null distributorSellNetPrice: 228.39 authorizedSellExtPrice: 228.39 UPCCode: '785901875246' authorizedUnitPrice: 76.13 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '5' - quoteLineId: a1B1K00000IieBSUAZ totalOrderQuantity: 6 catalogNumber: EDB14020 itemDesignation: PANEL H itemDescription: MINIATURE CIRCUIT BREAKER 277V 20A profileUnitNetPrice: 91.05 itemCategory: '00931' lineDisplayNumber: '42410412' spjRebate: true unitListPrice: 150 extendedPurchaserProfilePrice: 546.3 groupName: null distributorSellNetPrice: 102.42 authorizedSellExtPrice: 102.42 UPCCode: '785901878902' authorizedUnitPrice: 17.07 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '6' - quoteLineId: a1B1K00000IieBTUAZ totalOrderQuantity: 1 catalogNumber: MH44 itemDesignation: PANEL H itemDescription: PANELBOARD ENCLOSURE/BOX profileUnitNetPrice: 15.51 itemCategory: '07969' lineDisplayNumber: '42410413' spjRebate: true unitListPrice: 113 extendedPurchaserProfilePrice: 15.5 groupName: null distributorSellNetPrice: 15.5 authorizedSellExtPrice: 15.5 UPCCode: '785901378907' authorizedUnitPrice: 15.5 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '7' - quoteLineId: a1B1K00000IieBUUAZ totalOrderQuantity: 1 catalogNumber: NC44S itemDesignation: PANEL H itemDescription: PANELBOARD COVER/TRIM NF TYPE 1 S 44H profileUnitNetPrice: 445.54 itemCategory: '08352' lineDisplayNumber: '42410414' spjRebate: true unitListPrice: 663 extendedPurchaserProfilePrice: 445.54 groupName: null distributorSellNetPrice: 75.83 authorizedSellExtPrice: 75.83 UPCCode: '785901798880' authorizedUnitPrice: 75.83 sortSequenceGrid: 4 productSelectorMaterialSequenceID: '8' - quoteLineId: a1B1K00000IidnUUAR totalOrderQuantity: 1 catalogNumber: NQ442L2 itemDesignation: PANEL L itemDescription: PNLBD INT NQ 225A MLO 42 CKT 3P AL profileUnitNetPrice: 991.88 itemCategory: '09151' lineDisplayNumber: '42410720' spjRebate: true unitListPrice: 1476 extendedPurchaserProfilePrice: 991.87 groupName: null distributorSellNetPrice: 165.84 authorizedSellExtPrice: 165.84 UPCCode: '785901507864' authorizedUnitPrice: 165.84 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '1' - quoteLineId: a1B1K00000IidnVUAR totalOrderQuantity: 1 catalogNumber: PK27GTA itemDesignation: PANEL L itemDescription: LOAD CENTER EQUIPMENT GROUND BAR ASSY profileUnitNetPrice: 17.46 itemCategory: '00102' lineDisplayNumber: '42410721' spjRebate: true unitListPrice: 33.8 extendedPurchaserProfilePrice: 17.46 groupName: null distributorSellNetPrice: 4.36 authorizedSellExtPrice: 4.36 UPCCode: '785901156819' authorizedUnitPrice: 4.36 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '2' - quoteLineId: a1B1K00000IidnWUAR totalOrderQuantity: 2 catalogNumber: NQFP15 itemDesignation: PANEL L itemDescription: NQ FILLER PLATE KIT (15 PER PKG) profileUnitNetPrice: 45.7 itemCategory: '08332' lineDisplayNumber: '42410722' spjRebate: true unitListPrice: 68 extendedPurchaserProfilePrice: 91.39 groupName: null distributorSellNetPrice: 15.09 authorizedSellExtPrice: 15.09 UPCCode: '785901484288' authorizedUnitPrice: 7.55 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '3' - quoteLineId: a1B1K00000IieIbUAJ totalOrderQuantity: 1 catalogNumber: NQMB2Q itemDesignation: PANEL L itemDescription: PNLBD NQ MCB KIT FOR 225A MAX Q FRAME profileUnitNetPrice: 524.16 itemCategory: '09151' lineDisplayNumber: '42410723' spjRebate: true unitListPrice: 780 extendedPurchaserProfilePrice: 524.16 groupName: null distributorSellNetPrice: 87.64 authorizedSellExtPrice: 87.64 UPCCode: '785901666103' authorizedUnitPrice: 87.64 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '4' - quoteLineId: a1B1K00000IieIcUAJ totalOrderQuantity: 1 catalogNumber: QOB230 itemDesignation: PANEL L itemDescription: MINIATURE CIRCUIT BREAKER 120/240V 30A profileUnitNetPrice: 54.03 itemCategory: '00015' lineDisplayNumber: '42410724' spjRebate: true unitListPrice: 89 extendedPurchaserProfilePrice: 54.02 groupName: null distributorSellNetPrice: 10.22 authorizedSellExtPrice: 10.22 UPCCode: '785901416906' authorizedUnitPrice: 10.22 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '5' - quoteLineId: a1B1K00000IieIdUAJ totalOrderQuantity: 7 catalogNumber: QOB120 itemDesignation: PANEL L itemDescription: MINIATURE CIRCUIT BREAKER 120/240V 20A profileUnitNetPrice: 24.16 itemCategory: '00015' lineDisplayNumber: '42410725' spjRebate: true unitListPrice: 39.8 extendedPurchaserProfilePrice: 169.11 groupName: null distributorSellNetPrice: 31.99 authorizedSellExtPrice: 31.99 UPCCode: '785901416722' authorizedUnitPrice: 4.57 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '6' - quoteLineId: a1B1K00000IieIeUAJ totalOrderQuantity: 1 catalogNumber: QBL32100 itemDesignation: PANEL L itemDescription: MOLDED CASE CIRCUIT BREAKER 240V 100A profileUnitNetPrice: 757.54 itemCategory: '00023' lineDisplayNumber: '42410726' spjRebate: true unitListPrice: 1248 extendedPurchaserProfilePrice: 757.54 groupName: null distributorSellNetPrice: 183.44 authorizedSellExtPrice: 183.44 UPCCode: '785901702870' authorizedUnitPrice: 183.44 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '7' - quoteLineId: a1B1K00000IieIfUAJ totalOrderQuantity: 1 catalogNumber: MH50 itemDesignation: PANEL L itemDescription: PANELBOARD ENCLOSURE/BOX TYPE 1 50H 20W profileUnitNetPrice: 15.51 itemCategory: '07969' lineDisplayNumber: '42410727' spjRebate: true unitListPrice: 113 extendedPurchaserProfilePrice: 15.5 groupName: null distributorSellNetPrice: 15.5 authorizedSellExtPrice: 15.5 UPCCode: '785901378914' authorizedUnitPrice: 15.5 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '8' - quoteLineId: a1B1K00000IieIgUAJ totalOrderQuantity: 1 catalogNumber: NC50S itemDesignation: PANEL L itemDescription: PANELBOARD COVER/TRIM NF TYPE 1 S 50H profileUnitNetPrice: 489.89 itemCategory: '08352' lineDisplayNumber: '42410728' spjRebate: true unitListPrice: 729 extendedPurchaserProfilePrice: 489.89 groupName: null distributorSellNetPrice: 83.38 authorizedSellExtPrice: 83.38 UPCCode: '785901798903' authorizedUnitPrice: 83.38 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '9' '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.' components: schemas: QuoteLine: description: '' type: object x-examples: example-1: quoteLineId: a1B1K00000IieIgUAJ totalOrderQuantity: 1 catalogNumber: NC50S itemDesignation: PANEL L itemDescription: PANELBOARD COVER/TRIM NF TYPE 1 S 50H profileUnitNetPrice: 489.89 itemCategory: '08352' lineDisplayNumber: '42410728' spjRebate: true unitListPrice: 729 extendedPurchaserProfilePrice: 489.89 groupName: null distributorSellNetPrice: 83.38 authorizedSellExtPrice: 83.38 UPCCode: '785901798903' authorizedUnitPrice: 83.38 sortSequenceGrid: 5 productSelectorMaterialSequenceID: '9' title: '' properties: quoteLineId: type: string minLength: 1 description: Line item reference, for example 3 items might have 1, 2, 3 for line itme ref's. totalOrderQuantity: type: number description: | Total ordered for a line, sometimes items partiallys ship and need to know the total ordered catalogNumber: type: string minLength: 1 description: | SE Catalog Number of Commercial Reference identifier. Is different than UPC code. itemDesignation: type: string minLength: 1 description: The end user defines a designation of how they identify something. nullable: true itemDescription: type: string minLength: 1 description: SE catalog number description. Should match up with SE web page description for a catalog number. profileUnitNetPrice: type: number description: Distributor Profile price level. itemCategory: type: string minLength: 1 description: | Used for pricing. Each items assigned a category which has a unique level for each distributor. lineDisplayNumber: type: string minLength: 1 description: Number as it displays in systems like SE Advantage. spjRebate: type: boolean description: True / False - is this items a rebate item being fulfilled by the distributor. unitListPrice: type: number description: | List Price for a Catalog Number. Visbile on se.com website, public info. extendedPurchaserProfilePrice: type: number description: Profile price for the distributor times the number ordered. groupName: type: string description: Line Items can be grouped in SE Advantage. If the group is defined, this will have a value. Many times this will be blank or null. nullable: true distributorSellNetPrice: type: number description: | Agreed sell price per unit with the Distributor. authorizedSellExtPrice: type: number description: Distributor Sell Net Price time quantity for the line item. UPCCode: type: string minLength: 1 description: | UPC code for the catalog number reference. authorizedUnitPrice: type: number description: | SE has Authorized a special price for the items on a specific project. sortSequenceGrid: type: number description: In SE Advantage, controls the sorting ref of the list items. productSelectorMaterialSequenceID: type: string minLength: 1 description: For configured / complex edquipment, reference for the internal definition of that configuration. nullable: true required: - quoteLineId - totalOrderQuantity - catalogNumber - itemDesignation - itemDescription - profileUnitNetPrice - itemCategory - lineDisplayNumber - spjRebate - unitListPrice - extendedPurchaserProfilePrice - distributorSellNetPrice - authorizedSellExtPrice - UPCCode - authorizedUnitPrice - sortSequenceGrid - productSelectorMaterialSequenceID QuoteHeader: description: '' type: object x-examples: example-1: quoteId: a1F1K0000071Fm9UAE quoteName: SECTION STACK quoteNumber: Q-1599877 quoteStatus: Finalized authorizedTomv: 2700 billToAccountNumber: '38356' createdBy: David Cardamone createdDate: 2020-03-11T20:36:15.000+0000 billToAccountName: MAYER ELECTRIC SUP CO INC rebateExpirationDate: '2020-05-08' rebateOrderAcknowledged: true proposalName: SECTION STACK orderTomv: 0 totalRebateAmount: 6395.06 properties: quoteId: type: string minLength: 1 description: 'Identifier used in some SE systems. Not normally used by the Distrubitor, but extra reference. Example: quoteId: a1F1K0000071Fm9UAE' quoteName: type: string minLength: 1 description: The name of the quote...textual description. quoteNumber: type: string minLength: 1 description: Human readable / easily communicatable number generated by SE Advantage for the quote. quoteStatus: type: string minLength: 1 description: What is the status of the quote, Active, Closed, etc. authorizedTomv: type: number description: Total Order Motetary Value for the job/project. billToAccountNumber: type: string minLength: 1 description: SE identifier number for the distributor location. Normally a 5 digit ref number for a specific distributor location. createdBy: type: string minLength: 1 description: | Person who started/created the quote. createdDate: type: string minLength: 1 description: | Initial create date. billToAccountName: type: string minLength: 1 description: | Distributor's name. rebateExpirationDate: type: string minLength: 1 description: When the rebate timeframe will expire. rebateOrderAcknowledged: type: boolean description: True/False of rebate acknowledgement better SE and the Distributor. proposalName: type: string minLength: 1 description: Name of the Proposal which might have more than one Quote. orderTomv: type: number description: Total Order Monetarry Value for the quote/order. totalRebateAmount: type: number description: Total rebate amount for the project. required: - quoteId - quoteName - quoteNumber - quoteStatus - authorizedTomv - billToAccountNumber - createdBy - createdDate - billToAccountName - rebateExpirationDate - rebateOrderAcknowledged - proposalName - orderTomv - totalRebateAmount 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: 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/v1/pricing-quote/distributor/quote description: QA/test environment - url: https://api.se.com/v1/pricing-quote/distributor/quote description: Production server security: - OAuth2: []