> ## Documentation Index > Fetch the complete documentation index at: https://developer.orchestro.ai/llms.txt > Use this file to discover all available pages before exploring further. # Rates > This endpoint allows you to submit rate requests for various parcels by providing detailed shipment, account, and service information. It returns rate data for the shipment based on the provided attributes. ## OpenAPI ````yaml WMS_RSE.json post /api/v1/core/rates openapi: 3.0.3 info: title: Satge-e1-David-Sep13 description: This is an Open API Spec file version: 1.0.0 contact: {} servers: - url: https://api-stage.orchestro.ai/e1/ description: Sandbox Environment - url: https://api-stage.orchestro.ai description: Production Environment security: - ApiKeyAuth: [] tags: - name: WMS/RSE paths: /api/v1/core/rates: post: tags: - WMS/RSE summary: Rates description: >- This endpoint allows you to submit rate requests for various parcels by providing detailed shipment, account, and service information. It returns rate data for the shipment based on the provided attributes. operationId: rateRequest requestBody: description: >- This endpoint accepts a JSON request body that calculates shipping rates based on various parameters. The request includes details about the accounts involved, caller type, currency, label format, parcel specifications (such as dimensions and weight), shipping addresses, optional service attributes, and the shipment date. content: application/json: schema: type: object required: - fulfilmentNode properties: accounts: type: array description: A list of account information for the rate request. items: type: object properties: accountNumber: type: string description: >- Unique account number assigned to a shipper or logistics provider. example: AC0088 accountType: type: string description: Type of the account, such as SHIPPER or WMS. example: SHIPPER example: - accountNumber: AC0088 accountType: SHIPPER - accountNumber: AC0077 accountType: WMS callerType: type: string description: >- Defines the type of the caller submitting the rate request (e.g., WMS). example: WMS currency: type: string description: The currency for the rate request (e.g., USD). example: USD labelFormat: type: string description: The format for the generated shipping labels (e.g., PDF). example: PDF parcels: type: array description: >- A list of parcels to be rated, with details about their dimensions, weight, and shipping attributes. items: type: object properties: dimensions: type: object description: Dimensions of the parcel. properties: height: type: number description: Height of the parcel. example: 12 length: type: number description: Length of the parcel. example: 12 unit: type: string description: Unit of measurement (e.g., inch). example: inch width: type: number description: Width of the parcel. example: 12 parcelType: type: string description: Type of parcel (e.g., P for parcel). example: P pickupType: type: string description: The type of pickup service requested (e.g., Pickup). example: Pickup reference1: type: string description: Reference number for the shipment. example: '123456' reference2: type: string description: Secondary reference number for the shipment. example: '123456' referenceId: type: string description: Unique reference ID for the shipment. example: cf6fea899f1848b494d9568e8266e076 serviceAttributes: type: array description: >- Additional service attributes for the shipment (e.g., AD_SIGN for signature service). items: type: string example: AD_SIGN serviceType: type: string description: >- Type of shipping service (e.g., DGRD for dangerous goods). example: DGRD shipDate: type: string description: The date and time of shipment (ISO 8601 format). example: '2023-12-22T06:34:00' shipFrom: type: object description: Address from which the shipment is originating. properties: address1: type: string description: Primary address line. example: 280 S YORK RD address2: type: string description: Secondary address line. example: '' addressType: type: string description: Type of address (e.g., B for business). example: B city: type: string description: City of the origin address. example: BENSENVILLE company: type: string description: Name of the company at the origin address. example: SHIPPERZS ATTN NAME country: type: string description: >- Country code for the origin address (e.g., US for the United States). example: US email: type: string description: Email address for the shipper. example: '' name: type: string description: Name of the shipper. example: SHIPPERZS ATTN NAME phone: type: string description: Phone number of the shipper. example: '' state: type: string description: State or region of the origin address. example: IL zip: type: string description: ZIP or postal code of the origin address. example: '60106' shipTo: type: object description: Address to which the parcel is being shipped. properties: address1: type: string description: Primary address line. example: 637 E WOODBRIDGE AVE address2: type: string description: Secondary address line. example: '' addressType: type: string description: Type of address (e.g., B for business). example: B city: type: string description: City of the destination address. example: AVENEL company: type: string description: Name of the recipient company. example: Test-Company-Name country: type: string description: Country code for the destination address. example: US email: type: string description: Email address of the recipient. example: '' name: type: string description: Name of the recipient. example: JOSH SMITH phone: type: string description: Phone number of the recipient. example: '' state: type: string description: State or region of the destination address. example: NJ zip: type: string description: ZIP or postal code of the destination address. example: '07001' weight: type: object description: Weight of the parcel. properties: unit: type: string description: Unit of weight (e.g., oz for ounces). example: oz value: type: number description: Weight value of the parcel. example: 1 sendAllServiceAttributes: type: boolean description: >- Flag indicating whether all service attributes should be included in the response. example: true sendTNT: type: boolean description: >- Flag indicating whether time and transit details (TNT) should be included in the response. example: true shipmentDate: type: string description: The date and time of the shipment (ISO 8601 format). example: '2024-12-22T06:34:00' sortOrder: type: string description: >- Sort order for the returned rates (e.g., 'rate' to sort by price). example: rate fulfilmentNode: type: string example: NODE123 description: >- The identifier of the fulfilment node processing the shipment. examples: RATE Request 1 WMS (GRD): value: callerType: SHIPPER accounts: - accountNumber: AC0088 accountType: SHIPPER - accountNumber: AC0077 accountType: WMS sendAllServiceAttributes: 'true' sendTNT: 'true' shipmentDate: '2024-12-22T06:34:00' sortOrder: rate transitTime: '2024-12-22T06:34:00' zplEncoded: false currency: USD labelFormat: PNG labelLayout: '' fulfillmentNode: '' parcels: - quoteId: '' parcelType: P pickupType: Pickup reference1: testRef1 reference2: testRef2 referenceId: testRefId serviceAttributes: - AD_SIGN serviceType: GRD shipDate: '2024-08-22T06:34:00' shipFrom: company: Dallas City Hall name: The City Secretary's Office address1: 1500 Marilla Street address2: '' city: Dallas state: TX zip: '75201' country: US phone: '' email: '' addressType: B shipTo: company: Municipal Building name: Brooklyn Municipal Building address1: 210 Joralemon St address2: '' city: Brooklyn state: NY zip: '11201' country: US phone: 212-669-8090 email: '' addressType: B weight: unit: lb value: 6 dimensions: unit: inch height: 4 length: 4 width: 4 RATE Request 1 WMS (DGRD): value: callerType: WMS labelFormat: PDF accounts: - accountType: SHIPPER accountNumber: AC0088 - accountType: WMS accountNumber: AC0077 shipmentDate: '2024-12-22T06:34:00' sendTNT: true sortOrder: rate currency: USD sendAllServiceAttributes: true fulfillmentNode: '' parcels: - referenceId: cf6fea899f1848b494d9568e8266e076 reference1: 123456 reference2: 123456 shipDate: '2023-12-22T06:34:00' serviceType: DGRD pickupType: Pickup parcelType: P shipFrom: company: SHIPPERZS ATTN NAME name: SHIPPERZS ATTN NAME address1: 280 S YORK RD address2: '' city: BENSENVILLE state: IL zip: '60106' country: US phone: '' email: '' addressType: B shipTo: company: Test-Company-Name name: JOSH SMITH address1: 637 E WOODBRIDGE AVE address2: '' city: AVENEL state: NJ zip: '07001' country: US phone: '' email: '' addressType: B serviceAttributes: - AD_SIGN weight: value: 1 unit: oz dimensions: unit: inch length: 12 width: 12 height: 12 responses: '200': description: All successful rate responses. headers: Connection: schema: type: string example: keep-alive Content-Length: schema: type: string example: '153' Date: schema: type: string example: Tue, 17 Sep 2024 22:38:27 GMT Vary: schema: type: string example: Access-Control-Request-Headers Via: schema: type: string example: >- 1.1 ac8125882b03042c3557fc96ae234ffa.cloudfront.net (CloudFront) X-Amz-Cf-Id: schema: type: string example: tZxLqPY2-9Ob0bSAOfZZfTHw7AFQhdqwjBUMGykB24u66cni00noNw== X-Amz-Cf-Pop: schema: type: string example: CDG52-P3 X-Cache: schema: type: string example: Miss from cloudfront x-amz-apigw-id: schema: type: string example: eRWziEpkIAMEItQ= x-amzn-Remapped-Connection: schema: type: string example: keep-alive x-amzn-Remapped-Content-Length: schema: type: string example: '153' x-amzn-Remapped-Date: schema: type: string example: Tue, 17 Sep 2024 22:38:27 GMT x-amzn-RequestId: schema: type: string example: 9959633d-897c-4022-9f62-b4d1b738f74e content: application/json: schema: type: object properties: currency: type: string example: USD parcels: type: array items: type: object properties: dimensions: type: object properties: height: type: number example: 4 length: type: number example: 4 unit: type: string example: inch width: type: number example: 4 parcelType: type: string example: P pickupType: type: string example: Pickup quoteId: type: string example: 301312f9-500a-4e6a-8976-aad12db55e8c rates: type: array items: type: object properties: baseRate: type: number example: 4.59 destinationSortHub: type: string example: KEARNY serviceAttributes: type: array items: type: object properties: available: type: boolean example: false key: type: string example: AD_SIGN example: - available: false key: AD_SIGN serviceType: type: string example: GRD surcharges: type: array items: type: object properties: code: type: string example: FUEL description: type: string example: Carrier Fuel SurCharge rate: type: number example: 0.23 example: - code: FUEL description: Carrier Fuel SurCharge rate: 0.23 tnt: type: string example: 3 - 7 days totalRate: type: number example: 4.82 zone: type: number example: 1 example: - baseRate: 4.59 destinationSortHub: KEARNY serviceAttributes: - available: false key: AD_SIGN serviceType: GRD surcharges: - code: FUEL description: Carrier Fuel SurCharge rate: 0.23 tnt: 3 - 7 days totalRate: 4.82 zone: 1 referenceId: type: string example: testRefId serviceType: type: string example: GRD shipDate: type: string example: '2024-08-22T06:34:00' shipFrom: type: object properties: address1: type: string example: 1500 Marilla Street address2: type: string example: '' addressType: type: string example: B city: type: string example: Dallas company: type: string example: Dallas City Hall country: type: string example: US email: type: string example: '' name: type: string example: The City Secretary's Office phone: type: string example: '' state: type: string example: TX zip: type: string example: '75201' shipTo: type: object properties: address1: type: string example: 210 Joralemon St address2: type: string example: '' addressType: type: string example: B city: type: string example: Brooklyn company: type: string example: Municipal Building country: type: string example: US email: type: string example: '' name: type: string example: Brooklyn Municipal Building phone: type: string example: 212-669-8090 state: type: string example: NY zip: type: string example: '11201' weight: type: object properties: unit: type: string example: lb value: type: number example: 6 example: - dimensions: height: 4 length: 4 unit: inch width: 4 parcelType: P pickupType: Pickup quoteId: 301312f9-500a-4e6a-8976-aad12db55e8c rates: - baseRate: 4.59 destinationSortHub: KEARNY serviceAttributes: - available: false key: AD_SIGN serviceType: GRD surcharges: - code: FUEL description: Carrier Fuel SurCharge rate: 0.23 tnt: 3 - 7 days totalRate: 4.82 zone: 1 referenceId: testRefId serviceType: GRD shipDate: '2024-08-22T06:34:00' shipFrom: address1: 1500 Marilla Street address2: '' addressType: B city: Dallas company: Dallas City Hall country: US email: '' name: The City Secretary's Office phone: '' state: TX zip: '75201' shipTo: address1: 210 Joralemon St address2: '' addressType: B city: Brooklyn company: Municipal Building country: US email: '' name: Brooklyn Municipal Building phone: 212-669-8090 state: NY zip: '11201' weight: unit: lb value: 6 examples: RATE Response 1 WMS (GRD): value: currency: USD parcels: - quoteId: f387f8e4-901d-4578-9095-8b3838d30b47 referenceId: testRefId shipDate: '2024-08-22T06:34:00' serviceType: GRD pickupType: Pickup parcelType: P shipFrom: company: Dallas City Hall name: The City Secretary's Office address1: 1500 Marilla Street address2: '' city: Dallas state: TX zip: '75201' country: US phone: '' email: '' addressType: B shipTo: company: Municipal Building name: Brooklyn Municipal Building address1: 210 Joralemon St address2: '' city: Brooklyn state: NY zip: '11201' country: US phone: 212-669-8090 email: '' addressType: B weight: unit: lb value: 6 dimensions: unit: inch length: 4 width: 4 height: 4 rates: - zone: 6 serviceType: GRD tnt: 3 - 7 days baseRate: 7.06 totalRate: 7.41 totalDiscount: 1.2 baseRateDiscount: 0 surcharges: - rate: 3 discount: 0 code: Pick description: Pick Up Charges - rate: 0.75 discount: 0 code: PEAK description: Carrier Peak Surcharge - rate: 2 discount: 0 code: DDAS description: Delivery Area Surcharge - rate: 0.29 discount: 0 code: FUEL description: Fuel Surcharge serviceAttributes: - key: POD_RQD rate: 5 discount: 0.1 available: true destinationSortHub: KEARNY RATE Response 1 WMS (DGRD): value: currency: USD parcels: - quoteId: f387f8e4-901d-4578-9095-8b3838d30b47 referenceId: testRefId shipDate: '2024-08-22T06:34:00' serviceType: GRD pickupType: Pickup parcelType: P shipFrom: company: Dallas City Hall name: The City Secretary's Office address1: 1500 Marilla Street address2: '' city: Dallas state: TX zip: '75201' country: US phone: '' email: '' addressType: B shipTo: company: Municipal Building name: Brooklyn Municipal Building address1: 210 Joralemon St address2: '' city: Brooklyn state: NY zip: '11201' country: US phone: 212-669-8090 email: '' addressType: B weight: unit: lb value: 6 dimensions: unit: inch length: 4 width: 4 height: 4 rates: - zone: 6 serviceType: GRD tnt: 3 - 7 days baseRate: 7.06 totalRate: 7.41 totalDiscount: 1.2 baseRateDiscount: 0 surcharges: - rate: 3 discount: 0 code: Pick description: Pick Up Charges - rate: 0.75 discount: 0 code: PEAK description: Carrier Peak Surcharge - rate: 2 discount: 0 code: DDAS description: Delivery Area Surcharge - rate: 0.29 discount: 0 code: FUEL description: Fuel Surcharge serviceAttributes: - key: POD_RQD rate: 5 discount: 0.1 available: true destinationSortHub: KEARNY security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization ````