Giter Club home page Giter Club logo

companieshouse.orders.api.ch.gov.uk's Introduction

Companies House Orders API

orders.api.ch.gov.uk

API handling CRUD operations on CH Ordering Service

Requirements

Getting Started

  1. Run make to build
  2. Run ./start.sh to run

Environment Variables

Name Description Mandatory Location
ORDERS_API_PORT Port this application runs on when deployed. ✓ start.sh

Endpoints

Path Method Description
/basket PATCH Adds delivery details to basket.
/basket/items POST Adds requested item to basket.
/basket/checkouts POST Processes basket checkout. Creates a checkout resource.
/basket/checkouts/{checkoutId}/payment GET Returns paymentDetails resource for a valid checkoutId.
/basket/checkouts/{checkoutId}/payment PATCH Updates checkout resource with payment status.
/orders/{orderId} GET Returns OrderData resource for a valid orderId.
/healthcheck GET Returns HTTP OK (200) to indicate a healthy application instance.

companieshouse.orders.api.ch.gov.uk's People

Contributors

rjadhav-ch avatar nabeelamirch avatar caismith-ch avatar hwilliams1 avatar vaughanjackson123 avatar rafahop avatar ethatcher83 avatar jphillips2121 avatar macreman avatar damiandunajski avatar yiannispapastergiou avatar jsimons1989 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.