{ "openapi": "3.0.0", "info": { "title": "Shipstation Custom Store API", "version": "0.0.202002271202", "termsOfService": "https://www.shipstation.com/terms-of-service/", "x-logo": { "url": "https://www.shipstation.com/docs/api/img/media/logo-square.png", "backgroundColor": "#FFFFFF", "altText": "ShipStation logo" }, "contact": { "name": "ShipStation Sales & Support", "email": "sales@shipstation.com", "url": "https://info.shipstation.com/contact-sales", "x-phone": "1-512-485-4282" }, "description": "ShipStation already has over 100 marketplace integrations, but it's easy to add additional ones as well. By building a Custom Store API, any marketplace can integrate with ShipStation right alongside any our existing integrations.\n\nThe Custom Store API allows your orders to be imported into ShipStation with a single click. You can also be notified when orders have been shipped, including service details and tracking numbers.\n" }, "paths": { "/": { "summary": "API Root", "description": "Root description\n", "get": { "summary": "API Root", "description": "This endpoint is responsible for telling ShipStation a number of things sbout your Custom Store such as:\n - What version of the Custom Store spec you have implemented.\n - What endpoints you have chosen to implement and their corresponding HTTP methods.\n", "tags": [ "root" ], "operationId": "get_root", "responses": { "200": { "description": "Successfully retrieved the desired information about the Custom Store.", "content": { "application/json": { "schema": { "title": "root_response_body", "type": "object", "description": "Root Response Body", "additionalProperties": false, "required": [ "spec_version", "links" ], "properties": { "spec_version": { "title": "spec_version", "type": "string", "minLength": 5, "description": "The spec version of the Custom Store your web endpoints support." }, "links": { "allOf": [ { "title": "root_links", "type": "object", "description": "Object with the properties of function names that your Custom Store implements.\n", "additionalProperties": false, "required": [ "self", "orders" ], "properties": { "self": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root / endpoint." }, "orders": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root /orders endpoint." }, "events": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root /events endpoint." } } } ] } } } } } } } } }, "/events": { "summary": "Events", "description": "events", "post": { "summary": "Event Notifications", "description": "Allows ShipStation to send shipment information back to the shopping cart of the marketplace when an order is shipped, including shipping method, shipping status, tracking number, and more.\n", "tags": [ "events" ], "operationId": "get_events", "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "event_notifications_request_body", "type": "object", "description": "Event notifications that are sent to the Custom Store.", "additionalProperties": false, "required": [ "events" ], "properties": { "events": { "description": "An array of Event Notifications.", "type": "array", "items": { "allOf": [ { "title": "event", "type": "object", "description": "Event that will be sent to the Custom Store.\n", "additionalProperties": false, "required": [ "event_id", "type", "occurred_at", "event_id", "orders" ], "properties": { "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "type": { "allOf": [ { "title": "event_type", "description": "Event type.", "type": "string", "enum": [ "fulfilled" ] } ], "description": "The event type being sent. By default this will only be `fulfilled`, but your integration can request additional events.\n" }, "occurred_at": { "title": "occurred_at", "format": "date-time", "type": "string", "minLength": 1, "description": "Timestamp of when the event occurred." }, "shipment_id": { "title": "shipment_id", "type": "string", "minLength": 1, "description": "The shipment id." }, "tracking_number": { "title": "tracking_number", "type": "string", "minLength": 1, "description": "The tracking number associated with the shipping item." }, "carrier_code": { "title": "carrier_code", "type": "string", "minLength": 1, "description": "The carrier code that is associated with the notification event." }, "service_code": { "title": "service_code", "type": "string", "minLength": 1, "description": "The service code that is associated with the notification event." }, "orders": { "type": "array", "items": { "allOf": [ { "title": "event_order", "type": "object", "description": "An order associated with an event.", "additionalProperties": false, "required": [ "order_id", "items" ], "properties": { "order_id": { "type": "string", "minLength": 1, "description": "An order id associated with the order items." }, "items": { "type": "array", "description": "An array of objects which represent an item that's a part of the order.", "items": { "title": "item", "type": "object", "required": [ "item_id", "quantity" ], "properties": { "item_id": { "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order.\n" }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." } } } } } } ] }, "description": "An array objects that contains info on the orders associated with this notification event." } } } ] } } } } } } }, "responses": { "200": { "description": "The request was a success.", "content": { "text/plain": { "schema": { "title": "empty_response_body", "type": "string", "maxLength": 0 } }, "application/json": { "schema": { "title": "empty_response_body", "type": "string", "maxLength": 0 } } } }, "204": { "description": "The request was a success.", "content": { "text/plain": { "schema": { "title": "empty_response_body", "type": "string", "maxLength": 0 } }, "application/json": { "schema": { "title": "empty_response_body", "type": "string", "maxLength": 0 } } } }, "207": { "description": "The request was a success.", "content": { "application/json": { "schema": { "title": "event_notifications_response_body", "type": "object", "description": "Event notifications that are sent to ShipStation from the Custom Store.", "additionalProperties": false, "required": [ "events" ], "properties": { "events": { "type": "array", "description": "An array containing each notification to process.", "items": { "allOf": [ { "title": "event_response_item", "type": "object", "description": "Event that will be sent to the Custom Store.\n", "additionalProperties": false, "required": [ "event_id", "status" ], "properties": { "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "status": { "allOf": [ { "title": "event_status", "description": "Denotes whether the event status was received successfully.", "type": "string", "enum": [ "success", "failure" ] } ], "description": "Indicates which events were received and processsed successfully" } } } ] } } } } } } } } } }, "/orders": { "summary": "Orders", "post": { "summary": "Get Orders", "description": "Allows ShipStation to pull in order information from your Custom Store, including recipient address, products, customers, etc. \n", "tags": [ "orders" ], "operationId": "list_orders", "parameters": [ { "name": "created_at_start", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2019-03-12T19:24:13.657Z", "description": "Start date for order export. If omitted use the earliest order time." }, { "name": "created_at_end", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2019-03-12T19:24:13.657Z", "description": "End date for order export. If omitted use the current time." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "default": 1 }, "example": 2, "description": "The specific page of the paginated data what Shipstation would like to retrieve." } ], "responses": { "200": { "description": "The request was a success.", "content": { "application/json": { "schema": { "title": "orders_response_body", "type": "object", "description": "Orders Response Body", "additionalProperties": false, "required": [ "orders" ], "properties": { "page": { "type": "integer", "format": "int32", "minimum": 1 }, "pages": { "type": "integer", "format": "int32", "minimum": 1 }, "orders": { "type": "array", "items": { "allOf": [ { "title": "order", "description": "An object which represents an order placed through a cart or marketplace.", "type": "object", "additionalProperties": false, "required": [ "order_id", "order_source_code", "status", "fulfillment_status", "ship_to", "tax", "shipping_price", "payment_status", "items" ], "properties": { "order_id": { "title": "order_id", "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this order." }, "order_source_code": { "title": "order_source_code", "type": "string", "minLength": 1, "description": "The marketplace/order source that the order originated from." }, "created_at": { "title": "created_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that the order was placed." }, "modified_at": { "title": "modified_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that this order has most recently been modified." }, "status": { "allOf": [ { "title": "order_status", "description": "The overall order status.", "type": "string", "enum": [ "awaiting_payment", "awaiting_shipment", "cancelled", "completed", "on_hold", "pending_fulfillment" ] } ] }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "buyer": { "allOf": [ { "title": "buyer", "description": "Buyer related contact information", "type": "object", "additionalProperties": false, "properties": { "buyer_id": { "type": "string", "minLength": 1, "description": "An id or username used in your cart or marketplace to identify the buyer of this order.\n" }, "name": { "type": "string", "minLength": 1, "description": "The name to use for billing for this buyer." }, "phone": { "type": "string", "minLength": 10, "description": "The phone number to associate with billing for this buyer." }, "email": { "allOf": [ { "title": "email", "type": "string", "format": "email", "minLength": 6, "example": "john.doe@example.com", "description": "An email address." } ], "description": "The email to associate with billing info for this buyer." } } } ] }, "ship_to": { "allOf": [ { "title": "address", "description": "A mailing address.", "type": "object", "additionalProperties": false, "required": [ "address_line1", "city", "state_province", "postal_code", "country_code" ], "properties": { "name": { "title": "name", "type": "string", "minLength": 1, "description": "An object that holds the destination address of this order." }, "phone": { "title": "phone", "type": "string", "nullable": true, "description": "The phone number to associate with billing for this buyer." }, "company": { "title": "company", "type": "string", "minLength": 1, "description": "The company to use when shipping the order." }, "address_line1": { "title": "address_line1", "type": "string", "minLength": 1, "description": "Line 1 of the destination's address." }, "address_line2": { "title": "address_line2", "type": "string", "minLength": 1, "description": "Line 2 of the destination's address." }, "city": { "title": "city", "type": "string", "minLength": 1, "description": "The city of the destination's address." }, "state_province": { "title": "state_province", "type": "string", "minLength": 1, "description": "The state/province of the destination's address." }, "postal_code": { "title": "postal_code", "type": "string", "minLength": 5, "description": "The postal code or zip code of the destination's address." }, "country_code": { "title": "country_code", "type": "string", "minLength": 2, "description": "The country code of the destination's address." } } } ] }, "tax": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "shipping_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "price_adjustments": { "type": "array", "description": "An array of objects which represent adjustments to the total price which wouldn't fit into other cost fields.", "items": { "allOf": [ { "title": "price_adjustment", "type": "object", "additionalProperties": false, "description": "Represents adjustments to the total price which wouldn't fit into other cost fields.", "required": [ "type", "amount" ], "properties": { "type": { "allOf": [ { "title": "price_adjustments_type", "description": "Types of price adjustments.", "type": "string", "enum": [ "adjustment", "coupon", "credit", "debit", "discount", "duty", "fee", "gift_certificate", "promotion", "refund", "tariff", "tax", "other" ] } ] }, "amount": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] } } } ] } }, "payment_status": { "allOf": [ { "title": "payment_status", "description": "The status of the payment associated with the order.", "type": "string", "enum": [ "awaiting_payment", "payment_cancelled", "payment_failed", "payment_in_process", "paid", "other" ] } ], "description": "The status of this order's payment." }, "payment_method": { "title": "payment_method", "type": "string", "minLength": 1, "description": "The payment method used for this order." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "items": { "type": "array", "items": { "allOf": [ { "title": "order_items", "type": "object", "additionalProperties": false, "required": [ "item_id", "fulfillment_status", "name", "quantity", "unit_price", "total_price" ], "properties": { "item_id": { "type": "string", "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order." }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "name": { "type": "string", "description": "The name of the product." }, "sku": { "type": "string", "description": "The SKU of the product." }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." }, "weight": { "allOf": [ { "title": "weight_unit", "description": "An object that combines the weight unit and associated value.", "type": "object", "additionalProperties": false, "required": [ "value", "unit" ], "properties": { "value": { "type": "string", "description": "The ISO currency code associated with this amount.\n" }, "unit": { "type": "number", "description": "The amount of specified currency." } } } ], "description": "An object that holds weight information about the product." }, "unit_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the price per unit for this line item." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the total for this line item." }, "shipping_preferences": { "allOf": [ { "title": "shipping_preferences", "type": "object", "description": "An object that contains extra information about how this item should be shipped.\n", "required": [ "type" ], "properties": { "type": { "title": "shipping_preference_types", "description": "The type of shipping preference.", "type": "string", "enum": [ "confirmation", "delivery_date", "expedited_service", "contains_alcohol", "saturday_delivery" ] }, "confirmation": { "type": "string" }, "delivery_date": { "format": "date-time", "type": "string", "description": "The preferred delivery date for the shipping item." }, "expedited_service": { "type": "boolean", "description": "Indicates if the shipping item will be shipped using an expedited service." }, "contains_alcohol": { "type": "boolean", "description": "Indicates if the shipping item contains alcohol." }, "saturday_delivery": { "type": "boolean", "description": "Indicates if the shipping item will be a saturday delivery." }, "insured_value": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object that contains information on the value that the shipping item is insured for." }, "links": { "type": "array", "items": { "title": "link", "type": "object", "additionalProperties": false, "properties": { "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" } } } } } } ], "description": "An array of shipping_preference objects." } } } ] } }, "links": { "title": "links", "type": "object", "properties": { "self": { "title": "self", "type": "string", "minLength": 1, "description": "Link to the order in the user's custom store." } } }, "notes": { "type": "array", "items": { "title": "note", "type": "object", "additionalProperties": false, "description": "A note associated with an order.", "required": [ "type", "text" ], "properties": { "type": { "allOf": [ { "title": "shipping_notes_type", "description": "The types of shipping notes", "type": "string", "enum": [ "back_order_message", "condition_note", "gift_message", "internal_notes", "in_stock_message", "manufacturer_part_number", "notes_from_buyer", "notes_to_buyer", "other", "out_of_stock_message", "reason", "special_instructions", "warning_label", "feedback_message" ] } ] }, "text": { "title": "text", "type": "string", "minLength": 1, "description": "The text of the note." } } } } } } ] } } } } } } } } } } }, "servers": [], "components": { "schemas": { "root_response_body": { "title": "root_response_body", "type": "object", "description": "Root Response Body", "additionalProperties": false, "required": [ "spec_version", "links" ], "properties": { "spec_version": { "title": "spec_version", "type": "string", "minLength": 5, "description": "The spec version of the Custom Store your web endpoints support." }, "links": { "allOf": [ { "title": "root_links", "type": "object", "description": "Object with the properties of function names that your Custom Store implements.\n", "additionalProperties": false, "required": [ "self", "orders" ], "properties": { "self": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root / endpoint." }, "orders": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root /orders endpoint." }, "events": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root /events endpoint." } } } ] } } }, "spec_version": { "title": "spec_version", "type": "string", "minLength": 5, "description": "The spec version of the Custom Store your web endpoints support." }, "root_links": { "title": "root_links", "type": "object", "description": "Object with the properties of function names that your Custom Store implements.\n", "additionalProperties": false, "required": [ "self", "orders" ], "properties": { "self": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root / endpoint." }, "orders": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root /orders endpoint." }, "events": { "allOf": [ { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } } ], "description": "Contains HTTP route and method object for the root /events endpoint." } } }, "link_item": { "title": "link_item", "type": "object", "description": "Contains the endpoint and methods available for the specified endpoint.", "additionalProperties": false, "required": [ "href", "allow" ], "properties": { "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allow": { "type": "array", "description": "Array of allowed HTTP Methods", "items": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] } } } }, "href": { "title": "href", "type": "string", "minLength": 1, "description": "The Url link of the endpoint" }, "allowed_http_methods": { "title": "allowed_http_methods", "description": "HTTP methods that are allowed for the Custom Store API implementatin.", "type": "string", "enum": [ "GET", "POST" ] }, "event_notifications_request_body": { "title": "event_notifications_request_body", "type": "object", "description": "Event notifications that are sent to the Custom Store.", "additionalProperties": false, "required": [ "events" ], "properties": { "events": { "description": "An array of Event Notifications.", "type": "array", "items": { "allOf": [ { "title": "event", "type": "object", "description": "Event that will be sent to the Custom Store.\n", "additionalProperties": false, "required": [ "event_id", "type", "occurred_at", "event_id", "orders" ], "properties": { "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "type": { "allOf": [ { "title": "event_type", "description": "Event type.", "type": "string", "enum": [ "fulfilled" ] } ], "description": "The event type being sent. By default this will only be `fulfilled`, but your integration can request additional events.\n" }, "occurred_at": { "title": "occurred_at", "format": "date-time", "type": "string", "minLength": 1, "description": "Timestamp of when the event occurred." }, "shipment_id": { "title": "shipment_id", "type": "string", "minLength": 1, "description": "The shipment id." }, "tracking_number": { "title": "tracking_number", "type": "string", "minLength": 1, "description": "The tracking number associated with the shipping item." }, "carrier_code": { "title": "carrier_code", "type": "string", "minLength": 1, "description": "The carrier code that is associated with the notification event." }, "service_code": { "title": "service_code", "type": "string", "minLength": 1, "description": "The service code that is associated with the notification event." }, "orders": { "type": "array", "items": { "allOf": [ { "title": "event_order", "type": "object", "description": "An order associated with an event.", "additionalProperties": false, "required": [ "order_id", "items" ], "properties": { "order_id": { "type": "string", "minLength": 1, "description": "An order id associated with the order items." }, "items": { "type": "array", "description": "An array of objects which represent an item that's a part of the order.", "items": { "title": "item", "type": "object", "required": [ "item_id", "quantity" ], "properties": { "item_id": { "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order.\n" }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." } } } } } } ] }, "description": "An array objects that contains info on the orders associated with this notification event." } } } ] } } } }, "event": { "title": "event", "type": "object", "description": "Event that will be sent to the Custom Store.\n", "additionalProperties": false, "required": [ "event_id", "type", "occurred_at", "event_id", "orders" ], "properties": { "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "type": { "allOf": [ { "title": "event_type", "description": "Event type.", "type": "string", "enum": [ "fulfilled" ] } ], "description": "The event type being sent. By default this will only be `fulfilled`, but your integration can request additional events.\n" }, "occurred_at": { "title": "occurred_at", "format": "date-time", "type": "string", "minLength": 1, "description": "Timestamp of when the event occurred." }, "shipment_id": { "title": "shipment_id", "type": "string", "minLength": 1, "description": "The shipment id." }, "tracking_number": { "title": "tracking_number", "type": "string", "minLength": 1, "description": "The tracking number associated with the shipping item." }, "carrier_code": { "title": "carrier_code", "type": "string", "minLength": 1, "description": "The carrier code that is associated with the notification event." }, "service_code": { "title": "service_code", "type": "string", "minLength": 1, "description": "The service code that is associated with the notification event." }, "orders": { "type": "array", "items": { "allOf": [ { "title": "event_order", "type": "object", "description": "An order associated with an event.", "additionalProperties": false, "required": [ "order_id", "items" ], "properties": { "order_id": { "type": "string", "minLength": 1, "description": "An order id associated with the order items." }, "items": { "type": "array", "description": "An array of objects which represent an item that's a part of the order.", "items": { "title": "item", "type": "object", "required": [ "item_id", "quantity" ], "properties": { "item_id": { "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order.\n" }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." } } } } } } ] }, "description": "An array objects that contains info on the orders associated with this notification event." } } }, "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "event_type": { "title": "event_type", "description": "Event type.", "type": "string", "enum": [ "fulfilled" ] }, "occurred_at": { "title": "occurred_at", "format": "date-time", "type": "string", "minLength": 1, "description": "Timestamp of when the event occurred." }, "shipment_id": { "title": "shipment_id", "type": "string", "minLength": 1, "description": "The shipment id." }, "tracking_number": { "title": "tracking_number", "type": "string", "minLength": 1, "description": "The tracking number associated with the shipping item." }, "carrier_code": { "title": "carrier_code", "type": "string", "minLength": 1, "description": "The carrier code that is associated with the notification event." }, "service_code": { "title": "service_code", "type": "string", "minLength": 1, "description": "The service code that is associated with the notification event." }, "event_order": { "title": "event_order", "type": "object", "description": "An order associated with an event.", "additionalProperties": false, "required": [ "order_id", "items" ], "properties": { "order_id": { "type": "string", "minLength": 1, "description": "An order id associated with the order items." }, "items": { "type": "array", "description": "An array of objects which represent an item that's a part of the order.", "items": { "title": "item", "type": "object", "required": [ "item_id", "quantity" ], "properties": { "item_id": { "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order.\n" }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." } } } } } }, "item": { "title": "item", "type": "object", "required": [ "item_id", "quantity" ], "properties": { "item_id": { "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order.\n" }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." } } }, "empty_response_body": { "title": "empty_response_body", "type": "string", "maxLength": 0 }, "event_notifications_response_body": { "title": "event_notifications_response_body", "type": "object", "description": "Event notifications that are sent to ShipStation from the Custom Store.", "additionalProperties": false, "required": [ "events" ], "properties": { "events": { "type": "array", "description": "An array containing each notification to process.", "items": { "allOf": [ { "title": "event_response_item", "type": "object", "description": "Event that will be sent to the Custom Store.\n", "additionalProperties": false, "required": [ "event_id", "status" ], "properties": { "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "status": { "allOf": [ { "title": "event_status", "description": "Denotes whether the event status was received successfully.", "type": "string", "enum": [ "success", "failure" ] } ], "description": "Indicates which events were received and processsed successfully" } } } ] } } } }, "event_response_item": { "title": "event_response_item", "type": "object", "description": "Event that will be sent to the Custom Store.\n", "additionalProperties": false, "required": [ "event_id", "status" ], "properties": { "event_id": { "title": "event_id", "type": "string", "minLength": 1, "description": "An id to allow the Custom Store response to differentiate between events." }, "status": { "allOf": [ { "title": "event_status", "description": "Denotes whether the event status was received successfully.", "type": "string", "enum": [ "success", "failure" ] } ], "description": "Indicates which events were received and processsed successfully" } } }, "event_status": { "title": "event_status", "description": "Denotes whether the event status was received successfully.", "type": "string", "enum": [ "success", "failure" ] }, "orders_response_body": { "title": "orders_response_body", "type": "object", "description": "Orders Response Body", "additionalProperties": false, "required": [ "orders" ], "properties": { "page": { "type": "integer", "format": "int32", "minimum": 1 }, "pages": { "type": "integer", "format": "int32", "minimum": 1 }, "orders": { "type": "array", "items": { "allOf": [ { "title": "order", "description": "An object which represents an order placed through a cart or marketplace.", "type": "object", "additionalProperties": false, "required": [ "order_id", "order_source_code", "status", "fulfillment_status", "ship_to", "tax", "shipping_price", "payment_status", "items" ], "properties": { "order_id": { "title": "order_id", "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this order." }, "order_source_code": { "title": "order_source_code", "type": "string", "minLength": 1, "description": "The marketplace/order source that the order originated from." }, "created_at": { "title": "created_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that the order was placed." }, "modified_at": { "title": "modified_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that this order has most recently been modified." }, "status": { "allOf": [ { "title": "order_status", "description": "The overall order status.", "type": "string", "enum": [ "awaiting_payment", "awaiting_shipment", "cancelled", "completed", "on_hold", "pending_fulfillment" ] } ] }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "buyer": { "allOf": [ { "title": "buyer", "description": "Buyer related contact information", "type": "object", "additionalProperties": false, "properties": { "buyer_id": { "type": "string", "minLength": 1, "description": "An id or username used in your cart or marketplace to identify the buyer of this order.\n" }, "name": { "type": "string", "minLength": 1, "description": "The name to use for billing for this buyer." }, "phone": { "type": "string", "minLength": 10, "description": "The phone number to associate with billing for this buyer." }, "email": { "allOf": [ { "title": "email", "type": "string", "format": "email", "minLength": 6, "example": "john.doe@example.com", "description": "An email address." } ], "description": "The email to associate with billing info for this buyer." } } } ] }, "ship_to": { "allOf": [ { "title": "address", "description": "A mailing address.", "type": "object", "additionalProperties": false, "required": [ "address_line1", "city", "state_province", "postal_code", "country_code" ], "properties": { "name": { "title": "name", "type": "string", "minLength": 1, "description": "An object that holds the destination address of this order." }, "phone": { "title": "phone", "type": "string", "nullable": true, "description": "The phone number to associate with billing for this buyer." }, "company": { "title": "company", "type": "string", "minLength": 1, "description": "The company to use when shipping the order." }, "address_line1": { "title": "address_line1", "type": "string", "minLength": 1, "description": "Line 1 of the destination's address." }, "address_line2": { "title": "address_line2", "type": "string", "minLength": 1, "description": "Line 2 of the destination's address." }, "city": { "title": "city", "type": "string", "minLength": 1, "description": "The city of the destination's address." }, "state_province": { "title": "state_province", "type": "string", "minLength": 1, "description": "The state/province of the destination's address." }, "postal_code": { "title": "postal_code", "type": "string", "minLength": 5, "description": "The postal code or zip code of the destination's address." }, "country_code": { "title": "country_code", "type": "string", "minLength": 2, "description": "The country code of the destination's address." } } } ] }, "tax": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "shipping_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "price_adjustments": { "type": "array", "description": "An array of objects which represent adjustments to the total price which wouldn't fit into other cost fields.", "items": { "allOf": [ { "title": "price_adjustment", "type": "object", "additionalProperties": false, "description": "Represents adjustments to the total price which wouldn't fit into other cost fields.", "required": [ "type", "amount" ], "properties": { "type": { "allOf": [ { "title": "price_adjustments_type", "description": "Types of price adjustments.", "type": "string", "enum": [ "adjustment", "coupon", "credit", "debit", "discount", "duty", "fee", "gift_certificate", "promotion", "refund", "tariff", "tax", "other" ] } ] }, "amount": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] } } } ] } }, "payment_status": { "allOf": [ { "title": "payment_status", "description": "The status of the payment associated with the order.", "type": "string", "enum": [ "awaiting_payment", "payment_cancelled", "payment_failed", "payment_in_process", "paid", "other" ] } ], "description": "The status of this order's payment." }, "payment_method": { "title": "payment_method", "type": "string", "minLength": 1, "description": "The payment method used for this order." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "items": { "type": "array", "items": { "allOf": [ { "title": "order_items", "type": "object", "additionalProperties": false, "required": [ "item_id", "fulfillment_status", "name", "quantity", "unit_price", "total_price" ], "properties": { "item_id": { "type": "string", "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order." }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "name": { "type": "string", "description": "The name of the product." }, "sku": { "type": "string", "description": "The SKU of the product." }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." }, "weight": { "allOf": [ { "title": "weight_unit", "description": "An object that combines the weight unit and associated value.", "type": "object", "additionalProperties": false, "required": [ "value", "unit" ], "properties": { "value": { "type": "string", "description": "The ISO currency code associated with this amount.\n" }, "unit": { "type": "number", "description": "The amount of specified currency." } } } ], "description": "An object that holds weight information about the product." }, "unit_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the price per unit for this line item." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the total for this line item." }, "shipping_preferences": { "allOf": [ { "title": "shipping_preferences", "type": "object", "description": "An object that contains extra information about how this item should be shipped.\n", "required": [ "type" ], "properties": { "type": { "title": "shipping_preference_types", "description": "The type of shipping preference.", "type": "string", "enum": [ "confirmation", "delivery_date", "expedited_service", "contains_alcohol", "saturday_delivery" ] }, "confirmation": { "type": "string" }, "delivery_date": { "format": "date-time", "type": "string", "description": "The preferred delivery date for the shipping item." }, "expedited_service": { "type": "boolean", "description": "Indicates if the shipping item will be shipped using an expedited service." }, "contains_alcohol": { "type": "boolean", "description": "Indicates if the shipping item contains alcohol." }, "saturday_delivery": { "type": "boolean", "description": "Indicates if the shipping item will be a saturday delivery." }, "insured_value": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object that contains information on the value that the shipping item is insured for." }, "links": { "type": "array", "items": { "title": "link", "type": "object", "additionalProperties": false, "properties": { "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" } } } } } } ], "description": "An array of shipping_preference objects." } } } ] } }, "links": { "title": "links", "type": "object", "properties": { "self": { "title": "self", "type": "string", "minLength": 1, "description": "Link to the order in the user's custom store." } } }, "notes": { "type": "array", "items": { "title": "note", "type": "object", "additionalProperties": false, "description": "A note associated with an order.", "required": [ "type", "text" ], "properties": { "type": { "allOf": [ { "title": "shipping_notes_type", "description": "The types of shipping notes", "type": "string", "enum": [ "back_order_message", "condition_note", "gift_message", "internal_notes", "in_stock_message", "manufacturer_part_number", "notes_from_buyer", "notes_to_buyer", "other", "out_of_stock_message", "reason", "special_instructions", "warning_label", "feedback_message" ] } ] }, "text": { "title": "text", "type": "string", "minLength": 1, "description": "The text of the note." } } } } } } ] } } } }, "order": { "title": "order", "description": "An object which represents an order placed through a cart or marketplace.", "type": "object", "additionalProperties": false, "required": [ "order_id", "order_source_code", "status", "fulfillment_status", "ship_to", "tax", "shipping_price", "payment_status", "items" ], "properties": { "order_id": { "title": "order_id", "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this order." }, "order_source_code": { "title": "order_source_code", "type": "string", "minLength": 1, "description": "The marketplace/order source that the order originated from." }, "created_at": { "title": "created_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that the order was placed." }, "modified_at": { "title": "modified_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that this order has most recently been modified." }, "status": { "allOf": [ { "title": "order_status", "description": "The overall order status.", "type": "string", "enum": [ "awaiting_payment", "awaiting_shipment", "cancelled", "completed", "on_hold", "pending_fulfillment" ] } ] }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "buyer": { "allOf": [ { "title": "buyer", "description": "Buyer related contact information", "type": "object", "additionalProperties": false, "properties": { "buyer_id": { "type": "string", "minLength": 1, "description": "An id or username used in your cart or marketplace to identify the buyer of this order.\n" }, "name": { "type": "string", "minLength": 1, "description": "The name to use for billing for this buyer." }, "phone": { "type": "string", "minLength": 10, "description": "The phone number to associate with billing for this buyer." }, "email": { "allOf": [ { "title": "email", "type": "string", "format": "email", "minLength": 6, "example": "john.doe@example.com", "description": "An email address." } ], "description": "The email to associate with billing info for this buyer." } } } ] }, "ship_to": { "allOf": [ { "title": "address", "description": "A mailing address.", "type": "object", "additionalProperties": false, "required": [ "address_line1", "city", "state_province", "postal_code", "country_code" ], "properties": { "name": { "title": "name", "type": "string", "minLength": 1, "description": "An object that holds the destination address of this order." }, "phone": { "title": "phone", "type": "string", "nullable": true, "description": "The phone number to associate with billing for this buyer." }, "company": { "title": "company", "type": "string", "minLength": 1, "description": "The company to use when shipping the order." }, "address_line1": { "title": "address_line1", "type": "string", "minLength": 1, "description": "Line 1 of the destination's address." }, "address_line2": { "title": "address_line2", "type": "string", "minLength": 1, "description": "Line 2 of the destination's address." }, "city": { "title": "city", "type": "string", "minLength": 1, "description": "The city of the destination's address." }, "state_province": { "title": "state_province", "type": "string", "minLength": 1, "description": "The state/province of the destination's address." }, "postal_code": { "title": "postal_code", "type": "string", "minLength": 5, "description": "The postal code or zip code of the destination's address." }, "country_code": { "title": "country_code", "type": "string", "minLength": 2, "description": "The country code of the destination's address." } } } ] }, "tax": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "shipping_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "price_adjustments": { "type": "array", "description": "An array of objects which represent adjustments to the total price which wouldn't fit into other cost fields.", "items": { "allOf": [ { "title": "price_adjustment", "type": "object", "additionalProperties": false, "description": "Represents adjustments to the total price which wouldn't fit into other cost fields.", "required": [ "type", "amount" ], "properties": { "type": { "allOf": [ { "title": "price_adjustments_type", "description": "Types of price adjustments.", "type": "string", "enum": [ "adjustment", "coupon", "credit", "debit", "discount", "duty", "fee", "gift_certificate", "promotion", "refund", "tariff", "tax", "other" ] } ] }, "amount": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] } } } ] } }, "payment_status": { "allOf": [ { "title": "payment_status", "description": "The status of the payment associated with the order.", "type": "string", "enum": [ "awaiting_payment", "payment_cancelled", "payment_failed", "payment_in_process", "paid", "other" ] } ], "description": "The status of this order's payment." }, "payment_method": { "title": "payment_method", "type": "string", "minLength": 1, "description": "The payment method used for this order." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] }, "items": { "type": "array", "items": { "allOf": [ { "title": "order_items", "type": "object", "additionalProperties": false, "required": [ "item_id", "fulfillment_status", "name", "quantity", "unit_price", "total_price" ], "properties": { "item_id": { "type": "string", "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order." }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "name": { "type": "string", "description": "The name of the product." }, "sku": { "type": "string", "description": "The SKU of the product." }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." }, "weight": { "allOf": [ { "title": "weight_unit", "description": "An object that combines the weight unit and associated value.", "type": "object", "additionalProperties": false, "required": [ "value", "unit" ], "properties": { "value": { "type": "string", "description": "The ISO currency code associated with this amount.\n" }, "unit": { "type": "number", "description": "The amount of specified currency." } } } ], "description": "An object that holds weight information about the product." }, "unit_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the price per unit for this line item." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the total for this line item." }, "shipping_preferences": { "allOf": [ { "title": "shipping_preferences", "type": "object", "description": "An object that contains extra information about how this item should be shipped.\n", "required": [ "type" ], "properties": { "type": { "title": "shipping_preference_types", "description": "The type of shipping preference.", "type": "string", "enum": [ "confirmation", "delivery_date", "expedited_service", "contains_alcohol", "saturday_delivery" ] }, "confirmation": { "type": "string" }, "delivery_date": { "format": "date-time", "type": "string", "description": "The preferred delivery date for the shipping item." }, "expedited_service": { "type": "boolean", "description": "Indicates if the shipping item will be shipped using an expedited service." }, "contains_alcohol": { "type": "boolean", "description": "Indicates if the shipping item contains alcohol." }, "saturday_delivery": { "type": "boolean", "description": "Indicates if the shipping item will be a saturday delivery." }, "insured_value": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object that contains information on the value that the shipping item is insured for." }, "links": { "type": "array", "items": { "title": "link", "type": "object", "additionalProperties": false, "properties": { "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" } } } } } } ], "description": "An array of shipping_preference objects." } } } ] } }, "links": { "title": "links", "type": "object", "properties": { "self": { "title": "self", "type": "string", "minLength": 1, "description": "Link to the order in the user's custom store." } } }, "notes": { "type": "array", "items": { "title": "note", "type": "object", "additionalProperties": false, "description": "A note associated with an order.", "required": [ "type", "text" ], "properties": { "type": { "allOf": [ { "title": "shipping_notes_type", "description": "The types of shipping notes", "type": "string", "enum": [ "back_order_message", "condition_note", "gift_message", "internal_notes", "in_stock_message", "manufacturer_part_number", "notes_from_buyer", "notes_to_buyer", "other", "out_of_stock_message", "reason", "special_instructions", "warning_label", "feedback_message" ] } ] }, "text": { "title": "text", "type": "string", "minLength": 1, "description": "The text of the note." } } } } } }, "order_id": { "title": "order_id", "type": "string", "minLength": 1, "description": "The ID used by your cart or marketplace to uniquely identify this order." }, "order_source_code": { "title": "order_source_code", "type": "string", "minLength": 1, "description": "The marketplace/order source that the order originated from." }, "created_at": { "title": "created_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that the order was placed." }, "modified_at": { "title": "modified_at", "format": "date-time", "type": "string", "minLength": 1, "description": "The date/time that this order has most recently been modified." }, "order_status": { "title": "order_status", "description": "The overall order status.", "type": "string", "enum": [ "awaiting_payment", "awaiting_shipment", "cancelled", "completed", "on_hold", "pending_fulfillment" ] }, "fulfillment_status": { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] }, "buyer": { "title": "buyer", "description": "Buyer related contact information", "type": "object", "additionalProperties": false, "properties": { "buyer_id": { "type": "string", "minLength": 1, "description": "An id or username used in your cart or marketplace to identify the buyer of this order.\n" }, "name": { "type": "string", "minLength": 1, "description": "The name to use for billing for this buyer." }, "phone": { "type": "string", "minLength": 10, "description": "The phone number to associate with billing for this buyer." }, "email": { "allOf": [ { "title": "email", "type": "string", "format": "email", "minLength": 6, "example": "john.doe@example.com", "description": "An email address." } ], "description": "The email to associate with billing info for this buyer." } } }, "email": { "title": "email", "type": "string", "format": "email", "minLength": 6, "example": "john.doe@example.com", "description": "An email address." }, "address": { "title": "address", "description": "A mailing address.", "type": "object", "additionalProperties": false, "required": [ "address_line1", "city", "state_province", "postal_code", "country_code" ], "properties": { "name": { "title": "name", "type": "string", "minLength": 1, "description": "An object that holds the destination address of this order." }, "phone": { "title": "phone", "type": "string", "nullable": true, "description": "The phone number to associate with billing for this buyer." }, "company": { "title": "company", "type": "string", "minLength": 1, "description": "The company to use when shipping the order." }, "address_line1": { "title": "address_line1", "type": "string", "minLength": 1, "description": "Line 1 of the destination's address." }, "address_line2": { "title": "address_line2", "type": "string", "minLength": 1, "description": "Line 2 of the destination's address." }, "city": { "title": "city", "type": "string", "minLength": 1, "description": "The city of the destination's address." }, "state_province": { "title": "state_province", "type": "string", "minLength": 1, "description": "The state/province of the destination's address." }, "postal_code": { "title": "postal_code", "type": "string", "minLength": 5, "description": "The postal code or zip code of the destination's address." }, "country_code": { "title": "country_code", "type": "string", "minLength": 2, "description": "The country code of the destination's address." } } }, "name": { "title": "name", "type": "string", "minLength": 1, "description": "An object that holds the destination address of this order." }, "phone": { "title": "phone", "type": "string", "nullable": true, "description": "The phone number to associate with billing for this buyer." }, "company": { "title": "company", "type": "string", "minLength": 1, "description": "The company to use when shipping the order." }, "address_line1": { "title": "address_line1", "type": "string", "minLength": 1, "description": "Line 1 of the destination's address." }, "address_line2": { "title": "address_line2", "type": "string", "minLength": 1, "description": "Line 2 of the destination's address." }, "city": { "title": "city", "type": "string", "minLength": 1, "description": "The city of the destination's address." }, "state_province": { "title": "state_province", "type": "string", "minLength": 1, "description": "The state/province of the destination's address." }, "postal_code": { "title": "postal_code", "type": "string", "minLength": 5, "description": "The postal code or zip code of the destination's address." }, "country_code": { "title": "country_code", "type": "string", "minLength": 2, "description": "The country code of the destination's address." }, "monetary_unit": { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } }, "price_adjustment": { "title": "price_adjustment", "type": "object", "additionalProperties": false, "description": "Represents adjustments to the total price which wouldn't fit into other cost fields.", "required": [ "type", "amount" ], "properties": { "type": { "allOf": [ { "title": "price_adjustments_type", "description": "Types of price adjustments.", "type": "string", "enum": [ "adjustment", "coupon", "credit", "debit", "discount", "duty", "fee", "gift_certificate", "promotion", "refund", "tariff", "tax", "other" ] } ] }, "amount": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ] } } }, "price_adjustments_type": { "title": "price_adjustments_type", "description": "Types of price adjustments.", "type": "string", "enum": [ "adjustment", "coupon", "credit", "debit", "discount", "duty", "fee", "gift_certificate", "promotion", "refund", "tariff", "tax", "other" ] }, "payment_status": { "title": "payment_status", "description": "The status of the payment associated with the order.", "type": "string", "enum": [ "awaiting_payment", "payment_cancelled", "payment_failed", "payment_in_process", "paid", "other" ] }, "payment_method": { "title": "payment_method", "type": "string", "minLength": 1, "description": "The payment method used for this order." }, "order_items": { "title": "order_items", "type": "object", "additionalProperties": false, "required": [ "item_id", "fulfillment_status", "name", "quantity", "unit_price", "total_price" ], "properties": { "item_id": { "type": "string", "description": "The ID used by your cart or marketplace to uniquely identify this line item on the order." }, "fulfillment_status": { "allOf": [ { "title": "fulfillment_status", "description": "The status of the order fulfillment.", "type": "string", "enum": [ "fulfilled", "cancelled", "on_hold_per_marketplace", "partially_fulfilled", "unfulfilled", "unknown" ] } ] }, "name": { "type": "string", "description": "The name of the product." }, "sku": { "type": "string", "description": "The SKU of the product." }, "quantity": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of products being sold as part of this line item." }, "weight": { "allOf": [ { "title": "weight_unit", "description": "An object that combines the weight unit and associated value.", "type": "object", "additionalProperties": false, "required": [ "value", "unit" ], "properties": { "value": { "type": "string", "description": "The ISO currency code associated with this amount.\n" }, "unit": { "type": "number", "description": "The amount of specified currency." } } } ], "description": "An object that holds weight information about the product." }, "unit_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the price per unit for this line item." }, "total_price": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object which holds currency information for the total for this line item." }, "shipping_preferences": { "allOf": [ { "title": "shipping_preferences", "type": "object", "description": "An object that contains extra information about how this item should be shipped.\n", "required": [ "type" ], "properties": { "type": { "title": "shipping_preference_types", "description": "The type of shipping preference.", "type": "string", "enum": [ "confirmation", "delivery_date", "expedited_service", "contains_alcohol", "saturday_delivery" ] }, "confirmation": { "type": "string" }, "delivery_date": { "format": "date-time", "type": "string", "description": "The preferred delivery date for the shipping item." }, "expedited_service": { "type": "boolean", "description": "Indicates if the shipping item will be shipped using an expedited service." }, "contains_alcohol": { "type": "boolean", "description": "Indicates if the shipping item contains alcohol." }, "saturday_delivery": { "type": "boolean", "description": "Indicates if the shipping item will be a saturday delivery." }, "insured_value": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object that contains information on the value that the shipping item is insured for." }, "links": { "type": "array", "items": { "title": "link", "type": "object", "additionalProperties": false, "properties": { "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" } } } } } } ], "description": "An array of shipping_preference objects." } } }, "weight_unit": { "title": "weight_unit", "description": "An object that combines the weight unit and associated value.", "type": "object", "additionalProperties": false, "required": [ "value", "unit" ], "properties": { "value": { "type": "string", "description": "The ISO currency code associated with this amount.\n" }, "unit": { "type": "number", "description": "The amount of specified currency." } } }, "shipping_preferences": { "title": "shipping_preferences", "type": "object", "description": "An object that contains extra information about how this item should be shipped.\n", "required": [ "type" ], "properties": { "type": { "title": "shipping_preference_types", "description": "The type of shipping preference.", "type": "string", "enum": [ "confirmation", "delivery_date", "expedited_service", "contains_alcohol", "saturday_delivery" ] }, "confirmation": { "type": "string" }, "delivery_date": { "format": "date-time", "type": "string", "description": "The preferred delivery date for the shipping item." }, "expedited_service": { "type": "boolean", "description": "Indicates if the shipping item will be shipped using an expedited service." }, "contains_alcohol": { "type": "boolean", "description": "Indicates if the shipping item contains alcohol." }, "saturday_delivery": { "type": "boolean", "description": "Indicates if the shipping item will be a saturday delivery." }, "insured_value": { "allOf": [ { "title": "monetary_unit", "description": "An object that consists of the currency type and the currency value.", "type": "object", "additionalProperties": false, "required": [ "currency", "amount" ], "properties": { "currency": { "type": "string", "minLength": 2, "description": "The ISO currency code associated with this amount.\n" }, "amount": { "type": "number", "format": "double", "minimum": 0, "description": "The amount of specified currency." } } } ], "description": "An object that contains information on the value that the shipping item is insured for." }, "links": { "type": "array", "items": { "title": "link", "type": "object", "additionalProperties": false, "properties": { "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" } } } } } }, "shipping_preference_types": { "title": "shipping_preference_types", "description": "The type of shipping preference.", "type": "string", "enum": [ "confirmation", "delivery_date", "expedited_service", "contains_alcohol", "saturday_delivery" ] }, "link": { "title": "link", "type": "object", "additionalProperties": false, "properties": { "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" } } }, "category": { "title": "category", "type": "string", "description": "The url location of the item's category in the user's custom store." }, "product": { "title": "product", "type": "string", "description": "The url location of the item's product description in the user's custom store." }, "image": { "title": "image", "type": "string", "description": "The url location of the item's image." }, "thumbnail": { "title": "thumbnail", "type": "string", "description": "The url location of the item's thumbnail." }, "video": { "title": "video", "type": "string", "description": "The Url location of the item's video." }, "tracking": { "title": "tracking", "type": "string", "description": "The Url location of the item's tracking information" }, "links": { "title": "links", "type": "object", "properties": { "self": { "title": "self", "type": "string", "minLength": 1, "description": "Link to the order in the user's custom store." } } }, "self": { "title": "self", "type": "string", "minLength": 1, "description": "Link to the order in the user's custom store." }, "note": { "title": "note", "type": "object", "additionalProperties": false, "description": "A note associated with an order.", "required": [ "type", "text" ], "properties": { "type": { "allOf": [ { "title": "shipping_notes_type", "description": "The types of shipping notes", "type": "string", "enum": [ "back_order_message", "condition_note", "gift_message", "internal_notes", "in_stock_message", "manufacturer_part_number", "notes_from_buyer", "notes_to_buyer", "other", "out_of_stock_message", "reason", "special_instructions", "warning_label", "feedback_message" ] } ] }, "text": { "title": "text", "type": "string", "minLength": 1, "description": "The text of the note." } } }, "shipping_notes_type": { "title": "shipping_notes_type", "description": "The types of shipping notes", "type": "string", "enum": [ "back_order_message", "condition_note", "gift_message", "internal_notes", "in_stock_message", "manufacturer_part_number", "notes_from_buyer", "notes_to_buyer", "other", "out_of_stock_message", "reason", "special_instructions", "warning_label", "feedback_message" ] }, "text": { "title": "text", "type": "string", "minLength": 1, "description": "The text of the note." } }, "responses": {}, "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "BasicAuth", "description": "ShipStation supports Custom Store's which have [Basic Auth](https://www.shipstation.com/docs/custom-store/security/#basic-authentication) enabled. This will be configured when \nconnecting your CustomStore via the ShipStation dashboard.\n" }, "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "API-Key", "description": "**API-Key** is the default header name, can be customized to the user's needs. Please see the \n[Security docs](https://www.shipstation.com/docs/custom-store/security/#api-keys) for more info.\n" } } }, "tags": [ { "name": "events", "description": "Endpoints associated with Event Notifications and how ShipStation will notify the Custom Store about new\ninformation related to Order resources.\n", "x-displayName": "Events" }, { "name": "orders", "description": "Endpoints associated with Orders resources and the information that SHipStation expects in their related requests.\n", "x-displayName": "Orders" }, { "name": "root", "description": "Endpoints associated with the base path of your API.\n", "x-displayName": "Root" } ], "externalDocs": { "url": "https://www.shipstation.com/docs/custom-store", "description": "ShipStation's documentation is designed to help you start shipping as quickly as possible. With easy-to-follow tutorials, detailed reference docs, and ready-made recipes for common use cases, you'll see real results in no time at all.\n" } }