Loves Store Orders API

1.0.x
(0 reviews)
Love's Store Orders API

Loves Store Orders (System API)

  • Version: 1.0
  • Base URI: /api
  • Protocol: HTTPS

Overview

The Loves Store Orders System API allows clients to post store order transaction details and perform health checks. It is designed to integrate with Love's internal systems and follows standardized traits and types from the Love's Core Library.

Table of Contents

  • Authentication
  • Resources
    • Health Check
    • Store Order Transaction
  • Data Types
  • Security
  • Environments

Authentication

This API is secured using OAuth 2.0. Please refer to the security/schemes.raml for details on how to authenticate requests.

Resources

/health-check

Type: health-check (from Love's Health Check Resource Library)

Description: Used to verify the availability and health of the API service.

/transaction

Display Name: Store Order Transaction

Description: Endpoint to post store order transaction details.

Method: POST
  • Description: Submit store order transaction details.
  • Traits Applied: apiResponsesTrait (from Love's Core Library)
  • Request Body:
    • Content-Type: application/json
    • Type: storeOrderTransactionType (from types.raml)
    • Example:Included from /examples/storeOrderTransaction.json
  • Response:
    • Status Code: 201 Created
    • Content-Type: application/json
    • Type: storeOrderTransactionResponseType (from types.raml)

Data Types

Defined in: types/types.raml

  • storeOrderTransactionType: Structure of the transaction payload.
  • storeOrderTransactionResponseType: Structure of the response after posting a transaction.

Security

Defined in: security/schemes.raml

  • OAuth 2.0 security scheme for authenticating API requests.

Environments

You can find the environments by clicking on the API Instances button in the left pane. To try out the API you can use enable the mock services in the right pane.

Reviews