Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

shipstation-custom-store-openapi

shipstation13MIT0.0.1

The official OpenAPI 3.0 definitions for ShipStation Custom Store

openapi, shipstation, json, yaml, swagger

readme

OpenAPI Logo ShipStation™ Custom Store OpenAPI Definition

This repo contains the official OpenAPI 3.0 definitions for the Shipstation Custom Store API. You can use these definitions with any of countless OpenAPI tools to generate sample code, tests, mock servers, etc.

Which file to use

Depending on your preferences and/or tooling, you may choose to use one or more of the following files:

Path Description
openapi.yaml The entire ShipStation Custom Store OpenAPI definition, in a single YAML file. This file uses $ref pointers to reduce duplication and keep the file small and fairly human-readable.

Some OpenAPI tools don't support YAML or don't support $ref pointers, so you may need to use the openapi.json file instead.
openapi.json The entire ShipStation Custom Store OpenAPI definition, in a single JSON file. This file does not contain any $ref pointers, which means it should work with any OpenAPI tool.