# Xoserve Shipper API

**Canonical:** https://apis.io/apis/xoserve/xoserve-shipper-api/  
**Provider:** Xoserve — https://apis.io/providers/xoserve/  
**Base URL:** https://discoveryapi.correla.com/shipper/v1  
**Documentation:** https://discoveryapiportal.correla.com/api-details#api=shipper&operation=getShipper_1

Xoserve Shipper API is one of 2 APIs that [Xoserve](https://apis.io/providers/xoserve/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Gas, Supply Point, Annual Quantity, and Energy Markets. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, pricing, and 1 JSON Schema.

Bundled by Xoserve as the Supply Point Quantities service. Lets gas Shippers view the proposed Formula Year (Billing) Annual Quantity value for a meter point ahead of the late-March notification to the current Shipper, together with meter point and network information. A single GET operation filtered by MPRN, or by postcode combined with optional address detail (house_no, street, town, county, country, sub_building_name, dependent_street, dependent_local). Returns JSON or XML. Available to Gas Shippers only, after contract countersigning.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/openapi/xoserve-shipper-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/overlays/xoserve-shipper-api-overlay.yaml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/json-schema/xoserve-shipper-api-components.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/examples/xoserve-shipper-api-response-example.json
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/skills/xoserve-lookup-supply-point-quantities.md
- **APIReference** — https://discoveryapiportal.correla.com/api-details#api=shipper&operation=getShipper_1
- **Documentation** — https://www.xoserve.com/products-services/data-products/gas-apis/
- **Portal** — https://discoveryapiportal.correla.com/
- **SignUp** — https://discoveryapiportal.correla.com/signin
- **Pricing** — https://www.xoserve.com/media/7975/xoserve-try-before-you-buy-api-service-subscription-guide.pdf
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/apis.yml

## Other Xoserve APIs (1)

- [Xoserve Supplier API](https://apis.io/apis/xoserve/xoserve-supplier-api/)

## Tags

Gas, Supply Point, Annual Quantity, Energy Markets

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/xoserve/xoserve-shipper-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/xoserve/.