Skip to content

Instantly share code, notes, and snippets.

@stchr

stchr/shipstation-OpenApi3Json.json

Last active April 10, 2022 20:38
Show Gist options
  • Save stchr/5f1a3db6f264a00b490650872a290bf3 to your computer and use it in GitHub Desktop.
Save stchr/5f1a3db6f264a00b490650872a290bf3 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
shipstation-OpenApi3Json.json
{
"openapi": "3.0.0",
"info": {
"title": "ShipStation Developer Portal",
"description": "# Integrating with ShipStation\n\nShipStation strives to streamline shipping for online sellers, no matter where they sell their products online. We are continuously adding new marketplaces, shopping carts, and integration tools, because we know the e-commerce space is growing. \nAs a result, we’ve worked hard to provide developer resources to build custom integrations with ShipStation. If you’re interested in becoming a partner of ours, drop us a line by [filling out this form](http://www.shipstation.com/partners/shipstation-api-custom-store/) and we’ll get in touch.\n\nThere are two methods to integrate with ShipStation:\n\n* Custom Store Integration\n\n* ShipStation API\n\n## Custom Store Integration\n\nLooking for a more 1-to-1 relationship between ShipStation and your chosen selling platform? The Custom Store Integration is the ticket. Our custom store integration is just like any of our other selling channel integration, and could be eligible (based on internal review) as a branded option within the ShipStation admin. It also allows the user to sync orders within ShipStation in a single click, in addition to ShipStation automatically sending shipment status and tracking information \nupdates back to your cart or marketplace once a label is created. It’s the best way to sync up orders with ShipStation and have the most seamless experience.\n\nThe Custom Store allows you to perform two major functions:\n\n* Provide order information to ShipStation, including recipient address, products, customers, etc.\n\n* Receive tracking information when an order is shipped, including shipping method, shipping status, tracking number, and more\n\nTo integrate with the Custom Store, you must expose a web page that renders XML that adheres to the specification defined in the Custom Store Integration Guide. \nWe refer to this page as your “XML Endpoint”. If you can provide us an XML Endpoint, we can *pull* data from your endpoint just like we do with other marketplaces like eBay and Amazon.\n\n**To find out more about our Custom Store Integration, click here: [Custom Store Integration Guide](https://help.shipstation.com/hc/en-us/articles/205928478)**\n\n## ShipStation API\n\nOur API is available for any plan, and allows for read access to almost all data in your account, and write access to create specific objects, like Orders, Customers, and Products. \nThe API is a great way to get data directly to and from ShipStation, like creating products, customers, and querying order & shipping data. Please note that an API integration will not allow you to use your own MarketplaceID that could eventually be branded with your company's logo (see the Custom Store Integration above for that functionality).\n\n**This API allows developers to build applications that interface with the ShipStation platform. The API can be used to automate many tasks including:**\n\n+ Managing Orders\n\n+ Managing Shipments\n\n+ Creating Shipping Labels\n\n+ Retrieving Shipping Rates\n\n+ and more!!!\n\n**To learn more about our API, please review our API documentation below.**\n\n## Which one should I pick?\n\nThe method that's right for your integration very much depends on the type of integration you're planning on implementing. A Custom Store allows ShipStation to *pull* order information from your platform the very same way we *pull* data from marketplaces such as eBay, Amazon, and Shopify. Once an order has been shipped in ShipStation, ShipStation automatically *pushes* tracking information back to your custom store. Though the functionality afforded by this approach is limited to these 2 main functions, much of the *heavy lifting* is performed by ShipStation. Importing orders \nand sending tracking information is performed automatically by ShipStation, as long as your XML endpoint is available to receive our data.\n\nAn API integration, on the other hand, exposes much more functionality, but requires that the developer do much of the heavy lifting. Orders must be *pushed* to ShipStation by using our \"/orders/CreateOrder\" endpoint. The API allows developers to perform functions such as tagging an order, \nshipping an order, creating a shipping label (without an order), retrieving shipping rates, adding funds to a carrier account, creating a warehouse, listing products, and much more. The functionality the API affords are typical actions that a user would perform if using the web app.\n\n### Considerations\n\n* **Will your integration be the main order management tool for the online seller?** If so, the API's broader range of functionality may be the best option.\n\n* **Would you like your store integration to be a branded marketplace within the ShipStation admin?** When you integrate using the Custom Store Integration, you could be eligible to have your company branded within the ShipStation admin. A branded store could have the plugin's logo in the app,\nas well as an easier store setup, order sync, and reporting. Please note, ShipStation makes the final decision, based on integration and partner requirements, on which custom stores are branded within our application.\n\n# ShipStation API Requirements\n\n## End Point\n\nEndpoints are located at the following domain https://ssapi.shipstation.com/ and will need to have a specific reference added to return data. PLEASE NOTE: You cannot access this URL directly and must reference one of the specific endpoints below.\n\n## Authentication\n\nThe ShipStation API uses [Basic HTTP authentication](http://en.wikipedia.org/wiki/Basic_access_authentication). Use your ShipStation ``API Key`` as the username and ``API Secret`` as the password. You can find your ``API Key`` as the username and ``API Secret`` under Settings at https://ss.shipstation.com/#/settings/api .\n\nThe Authorization header is constructed as follows:\n\n+ Username (``API KEY``) and password (``API Secret``) are combined into a string \"username:password\"\n\n+ The resulting string is then encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line\n\n+ The authorization method and a space i.e. \"Basic \" is then put before the encoded string.\n\nFor example, if the ``API KEY`` given is 'ShipStation' and the ``API Secret`` is 'Rocks' then the header is formed as follows:\n\n+ Authorization: Basic U2hpcFN0YXRpb246Um9ja3M=\n\n## API Rate Limits\n\nIn an effort to ensure consistent application performance and increased scalability, we have implemented rate limiting on the ShipStation API. Your integration will need to be able to handle HTTP rate limiting status messages as defined below:\n\n**Response Headers**\n\nAll responses will include headers with status information about rate limiting.\n\n1. X-Rate-Limit-Limit: the maximum number of requests per minute to the endpoint\n\n2. X-Rate-Limit-Remaining: the available requests remaining in the current window\n\n3. X-Rate-Limit-Reset: the number of seconds remaining until the next window begins\n\n**Hitting the Limit**\n\nIf your application hits the rate limit, an HTTP 429 will be returned with this body:\n\n```\n{\n \"message\": \"Too Many Requests\"\n}\n```\n\nAnd these headers, assuming it is 40 seconds into the current window:\n\n```\n{\n \"X-Rate-Limit-Limit\": 60,\n \"X-Rate-Limit-Remaining\": 0,\n \"X-Rate-Limit-Reset\": 20\n}\n```\n\nWhen the limit is reached, your application should stop making requests until X-Rate-Limit-Reset seconds have elapsed. The current Rate limit for each set of the API Key and Secret is 40 requests per minute.\n\nIf you have any issues with the API, please email us at <apisupport@shipstation.com>\n\n## Server Responses\n\nStatus Code | Description\n------------|-------------\n``200`` | OK - The request was successful (some API calls may return 201 instead).\n``201`` | Created - The request was successful and a resource was created.\n``204`` | No Content - The request was successful but there is no representation to return (that is, the response is empty).\n``400`` | Bad Request - The request could not be understood or was missing required parameters.\n``401`` | Unauthorized - Authentication failed or user does not have permissions for the requested operation.\n``403`` | Forbidden - Access denied.\n``404`` | Not Found - Resource was not found.\n``405`` | Method Not Allowed - Requested method is not supported for the specified resource.\n``429`` | Too Many Requests - Exceeded ShipStation API limits. When the limit is reached, your application should stop making requests until X-Rate-Limit-Reset seconds have elapsed.\n``500`` | Internal Server Error - ShipStation has encountered an error.\n\n## DateTime Format and Time Zone\n\nShipStation uses the ISO 8601 combined format for dateTime stamps being submitted to and returned from the API. Please be sure to submit all dateTime values as follows:\n\nyyyy-mm-dd hh:mm:ss (24 hour notation). Example - ``2016-11-29 23:59:59``\n\nThe time zone represented in all API responses is PST/PDT. Similarly, ShipStation asks that you make all time zone convertions and submit any dateTime requests in PST/PDT.",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://ssapi.shipstation.com/",
"variables": {}
}
],
"paths": {
"/accounts/registeraccount": {
"post": {
"tags": [
"Accounts"
],
"summary": "Register Account",
"description": "Creates a new ShipStation account and generates an apiKey and apiSecret to be used by the newly created account. PLEASE NOTE: This endpoint does not require API key and API Secret credentials. The Authorization header can be left off. Use of this specific endpoint requires approval, and is meant only for direct partners of ShipStation. This is the only endpoint to require approval. All other endpoints listed in this document can be accessed by submitting proper authorization credentials in the header of the request. To become a direct partner of ShipStation, or to request more information on becoming a direct partner, we recommend reaching out to our Partners and Integrations team here: https://info.shipstation.com/become-a-partner-api-and-custom-store-integrations\nThe body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``firstName`` | string, required | First Name\n``lastName`` | string, required | Last Name\n``email`` | string, required | Email address. This will also be the username of the account.\n``password`` | string, required | Password to set for account access.\n``companyName`` | string, optional | Name of Company.\n``addr1`` | string, optional | Company Address - Street 1\n``addr2`` | string, optional | Company Address - Street 2\n``city`` | string, optional | Company Address - City\n``state`` | string, optional | Company Address - State \n``zip`` | string, optional | Company Address - Zip Code\n``countryCode`` |string, optional | Company Address - Country. Please use a 2-character country code.\n``phone`` | string, optional | Company Phone number.",
"operationId": "RegisterAccount",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterAccountrequest"
},
"example": "{\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"email\": \"jsmithtest@gmail.com\",\n \"password\": \"testpw1234\",\n \"shippingOriginCountryCode\": \"US\",\n \"companyName\": \"Droid Repair LLC\",\n \"addr1\": \"542 Midichlorian Rd.\",\n \"addr2\": \"\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78703\",\n \"countryCode\": \"US\",\n \"phone\": \"5124111234\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterAccountresponse"
},
"example": {
"message": "ShipStation account created.",
"sellerId": 123456,
"success": true,
"apiKey": "abcdt9845hjmgfklj3498gkljdkuyekl",
"apiSecret": "1234iou983lkj8mnxgfwu509hkhdy7u3"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/accounts/listtags": {
"get": {
"tags": [
"Accounts"
],
"summary": "List Tags",
"description": "Lists all tags defined for this account.",
"operationId": "ListTags",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListTagsresponse"
},
"description": ""
},
"example": [
{
"tagId": 8362,
"name": "Backorder",
"color": "#800080"
},
{
"tagId": 8324,
"name": "Canada",
"color": "#ff0000"
},
{
"tagId": 8336,
"name": "Fragile",
"color": "#33CCCC"
},
{
"tagId": 8221,
"name": "Repeat Buyer",
"color": "#CC99FF"
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/carriers": {
"get": {
"tags": [
"Carriers"
],
"summary": "List Carriers",
"description": "Lists all shipping providers connected to this account.",
"operationId": "ListCarriers",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListCarriersresponse"
},
"description": ""
},
"example": [
{
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": "null",
"shippingProviderId": 12345,
"primary": true
},
{
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS1234",
"requiresFundedAccount": true,
"balance": 2400.27,
"nickname": "Stamps.com 2",
"shippingProviderId": 12346,
"primary": false
},
{
"name": "UPS",
"code": "ups",
"accountNumber": "ABCR80",
"requiresFundedAccount": false,
"balance": 0,
"nickname": "null",
"shippingProviderId": 12347,
"primary": true
},
{
"name": "FedEx",
"code": "fedex",
"accountNumber": "297929999",
"requiresFundedAccount": false,
"balance": 0,
"nickname": "SS",
"shippingProviderId": 12348,
"primary": true
},
{
"name": "Endicia",
"code": "endicia",
"accountNumber": "913999",
"requiresFundedAccount": true,
"balance": 0,
"nickname": "null",
"shippingProviderId": 12349,
"primary": true
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/carriers/getcarrier?carrierCode={carrierCode}": {
"get": {
"tags": [
"Carriers"
],
"summary": "Get Carrier",
"description": "Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.",
"operationId": "GetCarrier",
"parameters": [
{
"name": "carrierCode",
"in": "path",
"description": "The code for the carrier account to retrieve.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "stamps_com"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCarrierresponse"
},
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": null,
"shippingProviderId": 12345,
"primary": true
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/carriers/addfunds": {
"post": {
"tags": [
"Carriers"
],
"summary": "Add Funds",
"description": "Adds funds to a carrier account using the payment information on file. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | The carrier to add funds to.\n ``amount`` | number, required | The dollar amount to add to the account. The minimum value that can be added is $10.00. The maximum value is $10,000.00.",
"operationId": "AddFunds",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddFundsrequest"
},
"example": "{\n \"carrierCode\": \"fedex\",\n \"amount\": 20.00\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddFundsresponse"
},
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.14
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/carriers/listpackages?carrierCode={carrierCode}": {
"get": {
"tags": [
"Carriers"
],
"summary": "List Packages",
"description": "Retrieves a list of packages for the specified carrier",
"operationId": "ListPackages",
"parameters": [
{
"name": "carrierCode",
"in": "path",
"description": "The carrier's code",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListPackagesresponse"
},
"description": ""
},
"example": [
{
"carrierCode": "express_1",
"code": "cubic",
"name": "Cubic",
"domestic": true,
"international": false
},
{
"carrierCode": "express_1",
"code": "dvd_flat_rate_box",
"name": "DVD Flat Rate Box",
"domestic": false,
"international": true
},
{
"carrierCode": "express_1",
"code": "flat_rate_envelope",
"name": "Flat Rate Envelope",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "flat_rate_legal_envelope",
"name": "Flat Rate Legal Envelope",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "flat_rate_padded_envelope",
"name": "Flat Rate Padded Envelope",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "large_envelope_or_flat",
"name": "Large Envelope or Flat",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "large_flat_rate_box",
"name": "Large Flat Rate Box",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "large_package",
"name": "Large Package (any side > 12\")",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "large_video_flat_rate_box",
"name": "Large Video Flat Rate Box",
"domestic": false,
"international": true
},
{
"carrierCode": "express_1",
"code": "letter",
"name": "Letter",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "medium_flat_rate_box",
"name": "Medium Flat Rate Box",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "package",
"name": "Package",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "regional_rate_box_a",
"name": "Regional Rate Box A",
"domestic": true,
"international": false
},
{
"carrierCode": "express_1",
"code": "regional_rate_box_b",
"name": "Regional Rate Box B",
"domestic": true,
"international": false
},
{
"carrierCode": "express_1",
"code": "regional_rate_box_c",
"name": "Regional Rate Box C",
"domestic": true,
"international": false
},
{
"carrierCode": "express_1",
"code": "small_flat_rate_box",
"name": "Small Flat Rate Box",
"domestic": true,
"international": true
},
{
"carrierCode": "express_1",
"code": "thick_envelope",
"name": "Thick Envelope",
"domestic": true,
"international": true
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/carriers/listservices?carrierCode={carrierCode}": {
"get": {
"tags": [
"Carriers"
],
"summary": "List Services",
"description": "Retrieves the list of available shipping services provided by the specified carrier",
"operationId": "ListServices",
"parameters": [
{
"name": "carrierCode",
"in": "path",
"description": "The carrier's code",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListServicesresponse"
},
"description": ""
},
"example": [
{
"carrierCode": "fedex",
"code": "fedex_ground",
"name": "FedEx Ground®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_home_delivery",
"name": "FedEx Home Delivery®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_2day",
"name": "FedEx 2Day®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_2day_am",
"name": "FedEx 2Day® A.M.",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_express_saver",
"name": "FedEx Express Saver®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_standard_overnight",
"name": "FedEx Standard Overnight®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_priority_overnight",
"name": "FedEx Priority Overnight®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_first_overnight",
"name": "FedEx First Overnight®",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_1_day_freight",
"name": "FedEx 1 Day® Freight",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_2_day_freight",
"name": "FedEx 2 Day® Freight",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_3_day_freight",
"name": "FedEx 3 Day® Freight",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_first_overnight_freight",
"name": "FedEx First Overnight® Freight",
"domestic": true,
"international": false
},
{
"carrierCode": "fedex",
"code": "fedex_ground_international",
"name": "FedEx Ground® International",
"domestic": false,
"international": true
},
{
"carrierCode": "fedex",
"code": "fedex_international_economy",
"name": "FedEx International Economy®",
"domestic": false,
"international": true
},
{
"carrierCode": "fedex",
"code": "fedex_international_priority",
"name": "FedEx International Priority®",
"domestic": false,
"international": true
},
{
"carrierCode": "fedex",
"code": "fedex_international_first",
"name": "FedEx International First®",
"domestic": false,
"international": true
},
{
"carrierCode": "fedex",
"code": "fedex_europe_first",
"name": "FedEx Europe First®",
"domestic": false,
"international": true
},
{
"carrierCode": "fedex",
"code": "fedex_international_economy_freight",
"name": "FedEx International Economy® Freight",
"domestic": false,
"international": true
},
{
"carrierCode": "fedex",
"code": "fedex_international_priority_freight",
"name": "FedEx International Priority® Freight",
"domestic": false,
"international": true
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/customers/{customerId}": {
"get": {
"tags": [
"Customers"
],
"summary": "Get Customer",
"description": "",
"operationId": "GetCustomer",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The system generated identifier for the Customer.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCustomerresponse"
},
"example": {
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.19\"",
"modifyDate": "\"2014-11-18T10:33:01.19\"",
"name": "Cam Newton",
"company": "Test Company",
"street1": "123 War Eagle Lane",
"street2": "",
"city": "Auburn",
"state": "AL",
"postalCode": "36830",
"countryCode": "US",
"phone": "555-555-5555",
"email": "supermancam@example.com",
"addressVerified": "Verified",
"marketplaceUsernames": [
{
"customerUserId": 67195020,
"customerId": 12345678,
"createDate": "\"2015-04-27T12:35:03.83\"",
"modifyDate": "\"2015-05-14T08:16:15.27\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "camtheman@gmail.com"
},
{
"customerUserId": 37568588,
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.197\"",
"modifyDate": "\"2014-11-18T10:33:01.197\"",
"marketplaceId": 36,
"marketplace": "WooCommerce",
"username": "supercam@example.com"
},
{
"customerUserId": 46038940,
"customerId": 12345678,
"createDate": "null",
"modifyDate": "null",
"marketplaceId": 67,
"marketplace": "TradeGecko",
"username": "camtheman@gmail.com"
}
],
"tags": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
]
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}": {
"get": {
"tags": [
"Customers"
],
"summary": "List Customers",
"description": "Obtains a list of customers that match the specified criteria.",
"operationId": "ListCustomers",
"parameters": [
{
"name": "stateCode",
"in": "path",
"description": "Returns customers that reside in the specified stateCode.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"in": "path",
"description": "Returns customers that reside in the specified countryCode.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "marketplaceId",
"in": "path",
"description": "Returns customers that purchased items from the specified marketplaceId.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "tagId",
"in": "path",
"description": "Returns customers that have been tagged with the specified tagId.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "sortBy",
"in": "path",
"description": "Sorts the order of the response based off the specified value.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortBy"
}
},
{
"name": "sortDir",
"in": "path",
"description": "Sets the direction of the sort order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortDir"
}
},
{
"name": "page",
"in": "path",
"description": "Page number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "pageSize",
"in": "path",
"description": "Requested page size. Max value is 500.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListCustomersresponse"
},
"example": {
"customers": [
{
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.19\"",
"modifyDate": "\"2014-11-18T10:33:01.19\"",
"name": "Cam Newton",
"company": "Test Company",
"street1": "123 War Eagle Lane",
"street2": "",
"city": "Auburn",
"state": "AL",
"postalCode": "36830",
"countryCode": "US",
"phone": "555-555-5555",
"email": "supermancam@example.com",
"addressVerified": "Verified",
"marketplaceUsernames": [
{
"customerUserId": 67195020,
"customerId": 12345678,
"createDate": "\"2015-04-27T12:35:03.83\"",
"modifyDate": "\"2015-05-14T08:16:15.27\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "camtheman@gmail.com"
},
{
"customerUserId": 37568588,
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.197\"",
"modifyDate": "\"2014-11-18T10:33:01.197\"",
"marketplaceId": 36,
"marketplace": "WooCommerce",
"username": "supercam@example.com"
},
{
"customerUserId": 46038940,
"customerId": 12345678,
"createDate": "null",
"modifyDate": "null",
"marketplaceId": 67,
"marketplace": "TradeGecko",
"username": "camtheman@gmail.com"
}
],
"tags": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
]
},
{
"customerId": 87654321,
"createDate": "\"2015-06-21T12:48:07.54\"",
"name": "Bo Jackson",
"company": "Test Company",
"street1": "456 Heisman Ave",
"street2": "",
"city": "Auburn",
"state": "AL",
"postalCode": "36830",
"countryCode": "US",
"phone": "555-555-5555",
"email": "boknows@example.com",
"addressVerified": "Verified",
"marketplaceUsernames": [
{
"customerUserId": 77215410,
"customerId": 87654321,
"createDate": "\"2015-08-27T14:36:05.75\"",
"modifyDate": "\"2015-09-01T09:18:25.31\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "boknows@gmail.com"
},
{
"customerUserId": 43759100,
"customerId": 87654321,
"createDate": "\"2015-07-05T11:38:01.197\"",
"modifyDate": "\"2015-07-05T11:38:01.197\"",
"marketplaceId": 36,
"marketplace": "WooCommerce",
"username": "boknows@example.com"
},
{
"customerUserId": 81565241,
"customerId": 87654321,
"createDate": "null",
"modifyDate": "null",
"marketplaceId": 67,
"marketplace": "TradeGecko",
"username": "bo@gmail.com"
}
],
"tags": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
]
}
],
"total": 2,
"page": 1,
"pages": 1
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/fulfillments": {
"get": {
"tags": [
"Fulfillments"
],
"summary": "List Fulfillments w/o parameters",
"description": "",
"operationId": "ListFulfillmentsW/oParameters",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFulfillmentsw~1oparametersresponse"
},
"example": {
"fulfillments": [
{
"fulfillmentId": 33974374,
"orderId": 191759016,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "783408231234",
"createDate": "2016-06-07T08:50:50.067",
"shipDate": "2016-06-07T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "USPS",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
},
{
"fulfillmentId": 246310,
"orderId": 193699927,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "664756278745",
"createDate": "2016-06-08T12:54:53.347",
"shipDate": "2016-06-08T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "FedEx",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
}
],
"total": 2,
"page": 1,
"pages": 0
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}": {
"get": {
"tags": [
"Fulfillments"
],
"summary": "List Fulfillments with parameters",
"description": "Obtains a list of fulfillments that match the specified criteria. Please note the following:\n- Orders that have been marked as shipped either through the UI or the API will appear in the response as they are considered fulfillments.\nAll of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\nUrl format with filters:\n```\nfulfillments?fulfillmentId={fulfillmentId}\n&orderId={orderId}\n&orderNumber={orderNumber}\n&trackingNumber={trackingNumber}\n&recipientName={recipientName}\n&createDateStart={createDateStart}\n&createDateEnd={createDateEnd}\n&shipDateStart={shipDateStart}\n&shipDateEnd={shipDateEnd}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```",
"operationId": "ListFulfillmentsWithParameters",
"parameters": [
{
"name": "fulfillmentId",
"in": "path",
"description": "Returns the fulfillment with the specified fulfillment ID.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "orderId",
"in": "path",
"description": "Returns fulfillments whose orders have the specified order ID.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "orderNumber",
"in": "path",
"description": "Returns fulfillments whose orders have the specified order number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "trackingNumber",
"in": "path",
"description": "Returns fulfillments with the specified tracking number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "recipientName",
"in": "path",
"description": "Returns fulfillments shipped to the specified recipient name.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "createDateStart",
"in": "path",
"description": "Returns fulfillments created on or after the specified ``createDate``",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01 00:00:00"
}
},
{
"name": "createDateEnd",
"in": "path",
"description": "Returns fulfillments created on or before the specified ``createDate``",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08 00:00:00"
}
},
{
"name": "shipDateStart",
"in": "path",
"description": "Returns fulfillments with the ``shipDate`` on or after the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01"
}
},
{
"name": "shipDateEnd",
"in": "path",
"description": "Returns fulfillments with the ``shipDate`` on or before the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08"
}
},
{
"name": "sortBy",
"in": "path",
"description": "Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending ``createDate``.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortBy1"
}
},
{
"name": "sortDir",
"in": "path",
"description": "Sets the direction of the sort order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortDir"
}
},
{
"name": "page",
"in": "path",
"description": "page number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "pageSize",
"in": "path",
"description": "page size.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFulfillmentswithparametersresponse"
},
"example": {
"fulfillments": [
{
"fulfillmentId": 33974374,
"orderId": 191759016,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "783408231234",
"createDate": "2016-06-07T08:50:50.067",
"shipDate": "2016-06-07T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "USPS",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
},
{
"fulfillmentId": 246310,
"orderId": 193699927,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "664756278745",
"createDate": "2016-06-08T12:54:53.347",
"shipDate": "2016-06-08T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "FedEx",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
}
],
"total": 2,
"page": 1,
"pages": 0
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/{orderId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Order",
"description": "Retrieves a single order from the database.",
"operationId": "GetOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The system generated identifier for the order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 123456789
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOrderresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
},
"delete": {
"tags": [
"Orders"
],
"summary": "Delete Order",
"description": "Removes order from ShipStation's UI. Note this is a \"soft\" delete action so the order will still exist in the database, but will be set to ``inactive``",
"operationId": "DeleteOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The system generated identifier for the order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 123456789
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteOrderresponse"
},
"example": {
"success": true,
"message": "The requested order has been deleted."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/addtag": {
"post": {
"tags": [
"Orders"
],
"summary": "Add Tag to Order",
"description": "Adds a tag to an order. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be tagged.\n``tagId`` | number, required | Identifies the tag that will be applied to the order.",
"operationId": "AddTagToOrder",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddTagtoOrderrequest"
},
"example": "{\n \"orderId\": 123456,\n \"tagId\": 1234\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddTagtoOrderresponse"
},
"example": {
"success": true,
"message": "Tag added successfully."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/assignuser": {
"post": {
"tags": [
"Orders"
],
"summary": "Assign User to Order",
"description": "Assigns a user to an order. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderIds`` | number, required | Identifies set of orders that will be assigned the user. Please note that if ANY of the orders within the array are not found, no orders will have a user assigned to them.\n``userId`` | number, required | Identifies the user that will be applied to the orders. It should contain a GUID of the user to be assigned to the array of orders.",
"operationId": "AssignUserToOrder",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignUsertoOrderrequest"
},
"example": "{\n \"orderIds\": [\n 123456789,\n 12345679\n ],\n \"userId\": \"123456AB-ab12-3c4d-5e67-89f1abc1defa\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignUsertoOrderresponse"
},
"example": {
"success": true,
"message": "User assigned successfully."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/createlabelfororder": {
"post": {
"tags": [
"Orders"
],
"summary": "Create Label for Order",
"description": "Creates a shipping label for a given order. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be shipped.\n``carrierCode`` | string, required | The code for the carrier that is to be used for the label.\n``serviceCode`` | string, required | The code for the shipping service that is to be used for the label.\n``confirmation`` | string, required | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.\n``shipDate`` | string, required | The date the order should be shipped.\n``weight`` | Weight, optional | Weight of the order. Use the [**Weight**](http://www.shipstation.com/developer-api/#/reference/model-weight) model.\n``dimensions`` | Dimensions, optional | Dimensions of the order. Use [**Dimensions**](http://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this label. Use the [**InsuranceOptions**](http://www.shipstation.com/developer-api/#/reference/model-insuranceoptions) model.\n``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](http://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the Customs information that can be used to generate customs documents for international orders. Use the [**AdvancedOptions**](http://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model.\n``testLabel`` | boolean, required | Specifies whether a test label should be created.",
"operationId": "CreateLabelForOrder",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLabelforOrderrequest"
},
"example": "{\n \"orderId\": 93348442,\n \"carrierCode\": \"fedex\",\n \"serviceCode\": \"fedex_2day\",\n \"packageCode\": \"package\",\n \"confirmation\": null,\n \"shipDate\": \"2014-04-03\",\n \"weight\": {\n \"value\": 2,\n \"units\": \"pounds\"\n },\n \"dimensions\": null,\n \"insuranceOptions\": null,\n \"internationalOptions\": null,\n \"advancedOptions\": null,\n \"testLabel\": false\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLabelforOrderresponse"
},
"example": {
"shipmentId": 72513480,
"shipmentCost": 7.3,
"insuranceCost": 0,
"trackingNumber": "248201115029520",
"labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEJDBV0jCz0LBV1jY0M9I4XkXAX9iDRDBZd8hUAuAEdGC7cKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveFswIDAgMjg4IDQzMl0vUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vQ29udGVudHMgMiAwIFIvUGFyZW50....",
"formData": null
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/createorder": {
"post": {
"tags": [
"Orders"
],
"summary": "Create/Update Order",
"description": "If the ``orderKey`` is specified, the method becomes idempotent and the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated through this method. ``cancelled`` and ``shipped`` are locked from modification through the API. The body of this request should specify an [**Order**](https://www.shipstation.com/developer-api/#/reference/model-order) object:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderNumber`` | string, required | A user-defined order number used to identify an order.\n``orderKey`` | string, optional | A user-provided key that should be unique to each order. If an orderKey is not provided, ShipStation will create a new order and generate a unique orderKey for that order. If the orderKey *is* provided, the **createorder** method will either: create a new order if the provided orderKey is not found, or, update the existing order if the orderKey is found.\n``orderDate`` | string, required | The date the order was placed.\n``paymentDate`` | string, optional | The date the order was paid for.\n``shipByDate`` | string, optional | The date the order is to be shipped before or on. This field is a suggested value generated by the order source/platform/cart and passed to ShipStation.\n``orderStatus`` | string, required | The order's status. Possible values: ``awaiting_payment``, ``awaiting_shipment``, ``shipped``, ``on_hold``, ``cancelled``\n``customerUsername`` | string, optional | The customer's username.\n``customerEmail`` | string, optional | The customer's email address.\n``billTo`` | Address, required | The recipients billing address. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n``shipTo`` | Address, required | The recipient's shipping address. Use the [**Address**](http://www.shipstation.com/developer-api/#/reference/model-address) model.\n``items`` | OrderItem, optional | An array of item objects. Use an array of [**OrderItem**](http://www.shipstation.com/developer-api/#/reference/model-orderitem) models.\n``amountPaid`` | number, optional | The total amount paid for the Order.\n``taxAmount`` | number, optional | The total tax amount for the Order.\n``shippingAmount`` | number, optional | Shipping amount paid by the customer, if any.\n``customerNotes`` | string, optional | Notes left by the customer when placing the order.\n``internalNotes`` | string, optional | Private notes that are only visible to the seller.\n``gift`` | boolean, optional | Specifies whether or not this Order is a gift\n``giftMessage`` | string, optional | Gift message left by the customer when placing the order.\n``paymentMethod`` | string, optional | Method of payment used by the customer.\n``requestedShippingService`` | string, optional |Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart and helps identify what shipping service the customer selected upon checkout.\n``carrierCode`` | string, optional | The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).\n``serviceCode`` | string, optional | The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).\n``packageCode`` | string, optional | The code for the package type that is to be used(or was used) when this order is shipped(was shipped).\n``confirmation`` | string, optional | The type of delivery confirmation that is to be used(or was used) when this order is shipped(was shipped). Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only. \n``shipDate`` | string, optional | The date the order was shipped.\n``weight`` | Weight, optional | Weight of the order. Use the [**Weight**](http://www.shipstation.com/developer-api/#/reference/model-weight) model.\n``dimensions`` | Dimensions, optional | Dimensions of the order. Use the [**Dimensions**](http://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this order. Use the [**InsuranceOptions**](http://www.shipstation.com/developer-api/#/reference/model-insuranceoptions) model.\n``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](http://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the [**AdvancedOptions**](http://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model.\n``tagIds``|number[]|Array of tagIds. Each tagId identifies a tag that has been associated with this order.",
"operationId": "Create/updateOrder",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create~1UpdateOrderrequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create~1UpdateOrderresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/createorders": {
"post": {
"tags": [
"Orders"
],
"summary": "Create/Update Multiple Orders",
"description": "This endpoint can be used to create or update multiple orders in one request. If the ``orderKey`` is specified in an order, the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated through this method. ``cancelled`` and ``shipped`` are locked from modification through the API.\nData Type |Description\n-------------------|-------------------\nOrder, required | An array of [**Order**](http://www.shipstation.com/developer-api/#/reference/model-order) objects (maximum of 100 per request)",
"operationId": "Create/updateMultipleOrders",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Create~1UpdateMultipleOrdersrequest"
},
"description": ""
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create~1UpdateMultipleOrdersresponse"
},
"example": {
"hasErrors": false,
"results": [
{
"orderId": 58345234,
"orderNumber": "TEST-ORDER-API-DOCS",
"orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"success": true,
"errorMessage": null
}
]
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/holduntil": {
"post": {
"tags": [
"Orders"
],
"summary": "Hold Order Until",
"description": "This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment.\nThe body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be held.\n``holdUntilDate`` | string, required | Date when order is moved from ``on_hold`` status to ``awaiting_shipment``.",
"operationId": "HoldOrderUntil",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HoldOrderUntilrequest"
},
"example": "{\n \"orderId\": 1072467,\n \"holdUntilDate\": \"2014-12-01\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HoldOrderUntilresponse"
},
"example": {
"success": true,
"message": "Order held successfully."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders": {
"get": {
"tags": [
"Orders"
],
"summary": "List Orders w/o parameters",
"description": "",
"operationId": "ListOrdersW/oParameters",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOrdersw~1oparametersresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders?customerName={customerName}&itemKeyword={itemKeyword}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&modifyDateStart={modifyDateStart}&modifyDateEnd={modifyDateEnd}&orderDateStart={orderDateStart}&orderDateEnd={orderDateEnd}&orderNumber={orderNumber}&orderStatus={orderStatus}&paymentDateStart={paymentDateStart}&paymentDateEnd={paymentDateEnd}&storeId={storeId}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}": {
"get": {
"tags": [
"Orders"
],
"summary": "List Orders with parameters",
"description": "Obtains a list of orders that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\nUrl format with filters:\n```\n/orders?customerName={customerName}\n&itemKeyword={itemKeyword}\n&createDateStart={createDateStart}\n&createDateEnd={createDateEnd}\n&modifyDateStart={modifyDateStart}\n&modifyDateEnd={modifyDateEnd}\n&orderDateStart={orderDateStart}\n&orderDateEnd={orderDateEnd}\n&orderNumber={orderNumber}\n&orderStatus={orderStatus}\n&paymentDateStart={paymentDateStart}\n&paymentDateEnd={paymentDateEnd}\n&storeId={storeId}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```",
"operationId": "ListOrdersWithParameters",
"parameters": [
{
"name": "customerName",
"in": "path",
"description": "Returns orders that match the specified name.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "Smith"
}
},
{
"name": "itemKeyword",
"in": "path",
"description": "Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "ABC123"
}
},
{
"name": "createDateStart",
"in": "path",
"description": "Returns orders that were created in ShipStation after the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01 00:00:00"
}
},
{
"name": "createDateEnd",
"in": "path",
"description": "Returns orders that were created in ShipStation before the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08 00:00:00"
}
},
{
"name": "modifyDateStart",
"in": "path",
"description": "Returns orders that were modified after the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01 00:00:00"
}
},
{
"name": "modifyDateEnd",
"in": "path",
"description": "Returns orders that were modified before the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08 00:00:00"
}
},
{
"name": "orderDateStart",
"in": "path",
"description": "Returns orders greater than the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01 00:00:00"
}
},
{
"name": "orderDateEnd",
"in": "path",
"description": "Returns orders less than or equal to the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08 00:00:00"
}
},
{
"name": "orderNumber",
"in": "path",
"description": "Filter by order number, performs a \"starts with\" search.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "12345"
}
},
{
"name": "orderStatus",
"in": "path",
"description": "Filter by order status. If left empty, orders of all statuses are returned.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/orderStatus"
}
},
{
"name": "paymentDateStart",
"in": "path",
"description": "Returns orders that were paid after the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01"
}
},
{
"name": "paymentDateEnd",
"in": "path",
"description": "Returns orders that were paid before the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08"
}
},
{
"name": "storeId",
"in": "path",
"description": "Filters orders to a single store. Call List Stores to obtain a list of store Ids.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 123456
}
},
{
"name": "sortBy",
"in": "path",
"description": "Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending ``orderId``.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortBy2"
}
},
{
"name": "sortDir",
"in": "path",
"description": "Sets the direction of the sort order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortDir"
}
},
{
"name": "page",
"in": "path",
"description": "Page number",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "path",
"description": "Requested page size. Max value is 500.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOrderswithparametersresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/listbytag?orderStatus={orderStatus}&tagId={tagId}&page={page}&pageSize={pageSize}": {
"get": {
"tags": [
"Orders"
],
"summary": "List Orders by Tag",
"description": "Lists all orders that match the specified status and tag ID.\nUrl format with filters:\n```\n/listbytag?orderStatus={orderStatus}\n&tagId={tagId}\n&page={page}\n&pageSize={pageSize}\n```",
"operationId": "ListOrdersByTag",
"parameters": [
{
"name": "orderStatus",
"in": "path",
"description": "The order's status.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/orderStatus"
}
},
{
"name": "tagId",
"in": "path",
"description": "ID of the tag. Call Accounts/ListTags to obtain a list of tags for this account.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "page",
"in": "path",
"description": "Page number",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "path",
"description": "Requested page size. Max value is 500.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOrdersbyTagresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/markasshipped": {
"post": {
"tags": [
"Orders"
],
"summary": "Mark an Order as Shipped",
"description": "Marks an order as shipped without creating a label in ShipStation. The body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``orderId`` | number, required | Identifies the order that will be marked as shipped.\n ``carrierCode`` | string, required | Code of the carrier that is marked as having shipped the order.\n ``shipDate`` | string, optional | Date order was shipped.\n ``trackingNumber`` | string, optional | Tracking number of shipment.\n ``notifyCustomer`` | boolean, optional | Specifies whether the customer should be notified of the shipment. Default value: false\n ``notifySalesChannel`` | boolean, optional | Specifies whether the sales channel should be notified of the shipment. Default value: false",
"operationId": "MarkAnOrderAsShipped",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkanOrderasShippedrequest"
},
"example": "{\n \"orderId\": 93348442,\n \"carrierCode\": \"usps\",\n \"shipDate\": \"2014-04-01\",\n \"trackingNumber\": \"913492493294329421\",\n \"notifyCustomer\": true,\n \"notifySalesChannel\": true\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkanOrderasShippedresponse"
},
"example": {
"orderId": 123456789,
"orderNumber": "ABC123"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/removetag": {
"post": {
"tags": [
"Orders"
],
"summary": "Remove Tag from Order",
"description": "Removes a tag from the specified order. The body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order whose tag will be removed.\n``tagId`` | number, required | Identifies the tag to remove.",
"operationId": "RemoveTagFromOrder",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveTagfromOrderrequest"
},
"example": "{\n \"orderId\": 123456,\n \"tagId\": 1234\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveTagfromOrderresponse"
},
"example": {
"success": true,
"message": "Tag removed successfully."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/restorefromhold": {
"post": {
"tags": [
"Orders"
],
"summary": "Restore Order from On Hold",
"description": "This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a holdUntil Date is attached to an order.\nThe body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderId`` | number, required | Identifies the order that will be restored to ``awaiting_shipment`` from ``on_hold``.",
"operationId": "RestoreOrderFromOnHold",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestoreOrderfromOnHoldrequest"
},
"example": "{\n \"orderId\": 1234567\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestoreOrderfromOnHoldresponse"
},
"example": {
"success": true,
"message": "The requested order has been restored"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/orders/unassignuser": {
"post": {
"tags": [
"Orders"
],
"summary": "Unassign User from Order",
"description": "Unassigns a user from an order. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderIds`` | number, required | Identifies set of orders that will have the user unassigned. Please note that if ANY of the orders within the array are not found, then no orders will have their users unassigned.",
"operationId": "UnassignUserFromOrder",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnassignUserfromOrderrequest"
},
"example": "{\n \"orderIds\": [\n 123456789,\n 12345679\n ]\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnassignUserfromOrderresponse"
},
"example": {
"success": true,
"message": "User unassigned successfully."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/products/{productId}": {
"get": {
"tags": [
"Products"
],
"summary": "Get Product",
"description": "",
"operationId": "GetProduct",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "The system generated identifier for the Product.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProductresponse"
},
"example": {
"aliases": null,
"productId": 12345678,
"sku": "1004",
"name": "Coffee Mug",
"price": 26,
"defaultCost": 0,
"length": 3,
"width": 3,
"height": 3,
"weightOz": 26,
"internalNotes": null,
"fulfillmentSku": "F1004",
"createDate": "2014-09-04T09:18:01.293",
"modifyDate": "2014-09-18T12:38:43.893",
"active": true,
"productCategory": {
"categoryId": 9999,
"name": "Door Closers"
},
"productType": null,
"warehouseLocation": "Bin 22",
"defaultCarrierCode": "fedex",
"defaultServiceCode": "fedex_home_delivery",
"defaultPackageCode": "package",
"defaultIntlCarrierCode": "ups",
"defaultIntlServiceCode": "ups_worldwide_saver",
"defaultIntlPackageCode": "package",
"defaultConfirmation": "direct_signature",
"defaultIntlConfirmation": "adult_signature",
"customsDescription": null,
"customsValue": null,
"customsTariffNo": null,
"customsCountryCode": null,
"noCustoms": null,
"tags": [
{
"tagId": 9180,
"name": "APItest"
}
]
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
},
"put": {
"tags": [
"Products"
],
"summary": "Update Product",
"description": "Updates an existing product. This call does not currently support partial updates. The entire resource must be provided in the body of the request.",
"operationId": "UpdateProduct",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "The system generated identifier for the Product.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345678
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductrequest"
},
"example": "{\n \"aliases\": null,\n \"productId\": 123456789,\n \"sku\": \"\",\n \"name\": \"Beautiful\",\n \"price\": 0,\n \"defaultCost\": null,\n \"length\": null,\n \"width\": null,\n \"height\": null,\n \"weightOz\": null,\n \"internalNotes\": null,\n \"fulfillmentSku\": null,\n \"active\": true,\n \"productCategory\": null,\n \"productType\": null,\n \"warehouseLocation\": null,\n \"defaultCarrierCode\": null,\n \"defaultServiceCode\": null,\n \"defaultPackageCode\": null,\n \"defaultIntlCarrierCode\": null,\n \"defaultIntlServiceCode\": null,\n \"defaultIntlPackageCode\": null,\n \"defaultConfirmation\": null,\n \"defaultIntlConfirmation\": null,\n \"customsDescription\": null,\n \"customsValue\": null,\n \"customsTariffNo\": null,\n \"customsCountryCode\": null,\n \"noCustoms\": null,\n \"tags\": null\n }"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductresponse"
},
"example": {
"success": true,
"message": "The requested product has been updated"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/products": {
"get": {
"tags": [
"Products"
],
"summary": "List Products w/o parameters",
"description": "",
"operationId": "ListProductsW/oParameters",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListProductsw~1oparametersresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/products?sku={sku}&name={name}&productCategoryId={productCategoryId}&productTypeId={productTypeId}&tagId={tagId}&startDate={startDate}&endDate={endDate}&showInactive={showInactive}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}": {
"get": {
"tags": [
"Products"
],
"summary": "List Products with parameters",
"description": "Obtains a list of products that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\nUrl format with filters:\n```\n/products?sku={sku}\n&name={name}\n&productCategoryId={productCategoryId}\n&productTypeId={productTypeId}\n&tagId={tagId}\n&startDate={startDate}\n&endDate={endDate}\n&showInactive={showInactive}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```",
"operationId": "ListProductsWithParameters",
"parameters": [
{
"name": "sku",
"in": "path",
"description": "Returns products that match the specified SKU.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "path",
"description": "Returns products that match the specified product name.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "productCategoryId",
"in": "path",
"description": "Returns products that match the specified productCategoryId.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "productTypeId",
"in": "path",
"description": "Returns products that match the specified productTypeId.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "tagId",
"in": "path",
"description": "Returns products that match the specified tagId.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "startDate",
"in": "path",
"description": "Returns products that were created after the specified date.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "endDate",
"in": "path",
"description": "Returns products that were created before the specified date.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "path",
"description": "Sorts the order of the response based off the specified value.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortBy3"
}
},
{
"name": "sortDir",
"in": "path",
"description": "Sets the direction of the sort order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortDir"
}
},
{
"name": "page",
"in": "path",
"description": "Page number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "path",
"description": "Requested page size. Max value is 500.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "showInactive",
"in": "path",
"description": "Specifies whether the list should include inactive products.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListProductswithparametersresponse"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/shipments": {
"get": {
"tags": [
"Shipments"
],
"summary": "List Shipments w/o parameters",
"description": "",
"operationId": "ListShipmentsW/oParameters",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListShipmentsw~1oparametersresponse"
},
"example": {
"shipments": [
{
"shipmentId": 33974374,
"orderId": 43945660,
"orderKey": "8061c220f0794a9b92460b8bae6837e4",
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100038-1",
"createDate": "2014-10-03T06:51:33.627",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681189",
"isReturnLabel": false,
"batchNumber": "100301",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 16079,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": "",
"street1": "12223 LOWDEN LN",
"street2": "",
"street3": null,
"city": "MANCHACA",
"state": "TX",
"postalCode": "78652-3602",
"country": "US",
"phone": "2101235544",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 56568665,
"lineItemKey": null,
"sku": "SQ3785739",
"name": "Potato Kitten -",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7565777,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
},
{
"shipmentId": 33974373,
"orderId": 43337328,
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100028",
"createDate": "2014-10-03T06:51:59.943",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681196",
"isReturnLabel": false,
"batchNumber": "100300",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 14265,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Luke Skywalker",
"company": "SS",
"street1": "2815 EXPOSITION BLVD",
"street2": "",
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78703-1221",
"country": "US",
"phone": "",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 55827278,
"lineItemKey": null,
"sku": "test",
"name": "test",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7541107,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
}
],
"total": 2,
"page": 1,
"pages": 0
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/shipments?recipientName={recipientName}&recipientCountryCode={recipientCountryCode}&orderNumber={orderNumber}&orderId={orderId}&carrierCode={carrierCode}&serviceCode={serviceCode}&trackingNumber={trackingNumber}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&voidDateStart={voidDateStart}&voidDateEnd={voidDateEnd}&storeId={storeId}&includeShipmentItems={includeShipmentItems}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}": {
"get": {
"tags": [
"Shipments"
],
"summary": "List Shipments with parameters",
"description": "Obtains a list of shipments that match the specified criteria. Please note the following:\n- Only valid shipments with labels generated in ShipStation will be returned in the response. Orders that have been marked as shipped either through the UI or the API will not appear as they are considered external shipments.\n- To include every shipment's associated shipmentItems in the response, be sure to set the `includeShipmentItems` parameter to `true`.\nAll of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:\nUrl format with filters:\n```\nshipments?recipientName={recipientName}\n&recipientCountryCode={recipientCountryCode}\n&orderNumber={orderNumber}\n&orderId={orderId}\n&carrierCode={carrierCode}\n&serviceCode={serviceCode}\n&trackingNumber={trackingNumber}\n&createDateStart={createDateStart}\n&createDateEnd={createDateEnd}\n&shipDateStart={shipDateStart}\n&shipDateEnd={shipDateEnd}\n&voidDateStart={voidDateStart}\n&voidDateEnd={voidDateEnd}\n&storeId={storeId}\n&includeShipmentItems={includeShipmentItems}\n&sortBy={sortBy}\n&sortDir={sortDir}\n&page={page}\n&pageSize={pageSize}\n```",
"operationId": "ListShipmentsWithParameters",
"parameters": [
{
"name": "recipientName",
"in": "path",
"description": "Returns shipments shipped to the specified recipient name.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "recipientCountryCode",
"in": "path",
"description": "Returns shipments shipped to the specified country code.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "orderNumber",
"in": "path",
"description": "Returns shipments whose orders have the specified order number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "orderId",
"in": "path",
"description": "Returns shipments whose orders have the specified order ID.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "carrierCode",
"in": "path",
"description": "Returns shipments shipped with the specified carrier.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "serviceCode",
"in": "path",
"description": "Returns shipments shipped with the specified shipping service.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "trackingNumber",
"in": "path",
"description": "Returns shipments with the specified tracking number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "createDateStart",
"in": "path",
"description": "Returns shipments created on or after the specified ``createDate``",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01 00:00:00"
}
},
{
"name": "createDateEnd",
"in": "path",
"description": "Returns shipments created on or before the specified ``createDate``",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08 00:00:00"
}
},
{
"name": "shipDateStart",
"in": "path",
"description": "Returns shipments with the ``shipDate`` on or after the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01"
}
},
{
"name": "shipDateEnd",
"in": "path",
"description": "Returns shipments with the ``shipDate`` on or before the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08"
}
},
{
"name": "voidDateStart",
"in": "path",
"description": "Returns shipments voided on or after the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-01 00:00:00"
}
},
{
"name": "voidDateEnd",
"in": "path",
"description": "Returns shipments voided on or before the specified date",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "2015-01-08 00:00:00"
}
},
{
"name": "storeId",
"in": "path",
"description": "Returns shipments whose orders belong to the specified store ID.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 304352
}
},
{
"name": "includeShipmentItems",
"in": "path",
"description": "Specifies whether to include shipment items with results Default value: false.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "boolean",
"example": false
}
},
{
"name": "sortBy",
"in": "path",
"description": "Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending ``createDate``.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortBy1"
}
},
{
"name": "sortDir",
"in": "path",
"description": "Sets the direction of the sort order.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/sortDir"
}
},
{
"name": "page",
"in": "path",
"description": "page number.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "pageSize",
"in": "path",
"description": "page size.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListShipmentswithparametersresponse"
},
"example": {
"shipments": [
{
"shipmentId": 33974374,
"orderId": 43945660,
"orderKey": "8061c220f0794a9b92460b8bae6837e4",
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100038-1",
"createDate": "2014-10-03T06:51:33.627",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681189",
"isReturnLabel": false,
"batchNumber": "100301",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 16079,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": "",
"street1": "12223 LOWDEN LN",
"street2": "",
"street3": null,
"city": "MANCHACA",
"state": "TX",
"postalCode": "78652-3602",
"country": "US",
"phone": "2101235544",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 56568665,
"lineItemKey": null,
"sku": "SQ3785739",
"name": "Potato Kitten -",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7565777,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
},
{
"shipmentId": 33974373,
"orderId": 43337328,
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100028",
"createDate": "2014-10-03T06:51:59.943",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681196",
"isReturnLabel": false,
"batchNumber": "100300",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 14265,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Luke Skywalker",
"company": "SS",
"street1": "2815 EXPOSITION BLVD",
"street2": "",
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78703-1221",
"country": "US",
"phone": "",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 55827278,
"lineItemKey": null,
"sku": "test",
"name": "test",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7541107,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
}
],
"total": 2,
"page": 1,
"pages": 0
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/shipments/createlabel": {
"post": {
"tags": [
"Shipments"
],
"summary": "Create Shipment Label",
"description": "Creates a shipping label. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | Identifies the carrier to be used for this label.\n ``serviceCode`` | string, required | Identifies the shipping service to be used for this label.\n ``packageCode`` | string, required | Identifies the packing type that should be used for this label.\n ``confirmation`` | string, optional | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.\n ``shipDate`` | string, required | The date the shipment will be shipped.\n ``weight`` | Weight, required | Shipment's weight. Use the [**Weight**](https://www.shipstation.com/developer-api/#/reference/model-weight) model.\n ``dimensions`` | Dimensions, optional | Shipment's dimensions. Use the [**Dimensions**](https://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n ``shipFrom`` | Address, required | Address indicating shipment's origin. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``shipTo`` | Address, required | Address indicating shipment's destination. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``returnTo`` | Address, optional | Address indicating return address displayed on the label. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this order. \n ``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](https://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n ``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the [**AdvancedOptions**](https://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model. \n ``testLabel`` | boolean, optional | Specifies whether a test label should be created. Default value: false.",
"operationId": "CreateShipmentLabel",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateShipmentLabelrequest"
},
"example": "{\n \"carrierCode\": \"fedex\",\n \"serviceCode\": \"fedex_ground\",\n \"packageCode\": \"package\",\n \"confirmation\": \"delivery\",\n \"shipDate\": \"2014-04-03\",\n \"weight\": {\n \"value\": 3,\n \"units\": \"ounces\"\n },\n \"dimensions\": {\n \"units\": \"inches\",\n \"length\": 7,\n \"width\": 5,\n \"height\": 6\n },\n \"shipFrom\": {\n \"name\": \"Jason Hodges\",\n \"company\": \"ShipStation\",\n \"street1\": \"2815 Exposition Blvd\",\n \"street2\": \"Ste 2353242\",\n \"street3\": null,\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postalCode\": \"78703\",\n \"country\": \"US\",\n \"phone\": null,\n \"residential\": false\n },\n \"shipTo\": {\n \"name\": \"The President\",\n \"company\": \"US Govt\",\n \"street1\": \"1600 Pennsylvania Ave\",\n \"street2\": \"Oval Office\",\n \"street3\": null,\n \"city\": \"Washington\",\n \"state\": \"DC\",\n \"postalCode\": \"20500\",\n \"country\": \"US\",\n \"phone\": null,\n \"residential\": false\n },\n \"insuranceOptions\": null,\n \"internationalOptions\": null,\n \"advancedOptions\": null,\n \"testLabel\": false\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateShipmentLabelresponse"
},
"example": {
"shipmentId": 123456789,
"orderId": null,
"userId": null,
"customerEmail": null,
"orderNumber": null,
"createDate": "2016-04-03T12:11:36.863",
"shipDate": "2016-04-03",
"shipmentCost": 9.06,
"insuranceCost": 0,
"trackingNumber": "782390443992",
"isReturnLabel": false,
"batchNumber": null,
"carrierCode": "fedex",
"serviceCode": "fedex_ground",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": null,
"voided": false,
"voidDate": null,
"marketplaceNotified": false,
"notifyErrorMessage": null,
"shipTo": null,
"weight": null,
"dimensions": null,
"insuranceOptions": null,
"advancedOptions": null,
"shipmentItems": null,
"labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2U...",
"formData": null
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/shipments/getrates": {
"post": {
"tags": [
"Shipments"
],
"summary": "Get Rates",
"description": "Retrieves shipping rates for the specified shipping details. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | Returns rates for the specified carrier.\n ``serviceCode`` | string, optional | Returns rates for the specified shipping service.\n ``packageCode`` | string, optional | Returns rates for the specified package type.\n ``fromPostalCode`` | string, required | Originating postal code.\n ``toState`` | string, optional | Destination State/Province. Please use two-character state/province abbreviation. Note this field is required for the following carriers: UPS\n ``toCountry`` | string, required | Destination Country. Please use the two-character ISO country code.\n ``toPostalCode`` | string, required | Destination Postal Code.\n ``toCity`` | string, optional | Destination City.\n ``weight`` | Weight, required | Shipment's weight. Use ``Weight`` object.\n ``dimensions`` | Dimensions, optional | Shipment's dimensions. Use ``Dimensions`` object. \n ``confirmation`` | string, optional | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.\n ``residential`` | boolean, optional | Returns rates that account for the specified delivery confirmation type. Default value: false",
"operationId": "GetRates",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetRatesrequest"
},
"example": "{\n \"carrierCode\": \"fedex\",\n \"serviceCode\": null,\n \"packageCode\": null,\n \"fromPostalCode\": \"78703\",\n \"toState\": \"DC\",\n \"toCountry\": \"US\",\n \"toPostalCode\": \"20500\",\n \"toCity\": \"Washington\",\n \"weight\": {\n \"value\": 3,\n \"units\": \"ounces\"\n },\n \"dimensions\": {\n \"units\": \"inches\",\n \"length\": 7,\n \"width\": 5,\n \"height\": 6\n },\n \"confirmation\": \"delivery\",\n \"residential\": false\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetRatesresponse"
},
"description": ""
},
"example": [
{
"serviceName": "FedEx First Overnight®",
"serviceCode": "fedex_first_overnight",
"shipmentCost": 87.8,
"otherCost": 2.63
},
{
"serviceName": "FedEx Priority Overnight®",
"serviceCode": "fedex_priority_overnight",
"shipmentCost": 50.23,
"otherCost": 1.51
},
{
"serviceName": "FedEx Standard Overnight®",
"serviceCode": "fedex_standard_overnight",
"shipmentCost": 46.96,
"otherCost": 1.41
},
{
"serviceName": "FedEx 2Day® A.M.",
"serviceCode": "fedex_2day_am",
"shipmentCost": 23.04,
"otherCost": 0.69
},
{
"serviceName": "FedEx 2Day®",
"serviceCode": "fedex_2day",
"shipmentCost": 20.03,
"otherCost": 0.6
},
{
"serviceName": "FedEx Express Saver®",
"serviceCode": "fedex_express_saver",
"shipmentCost": 14.28,
"otherCost": 0.43
},
{
"serviceName": "FedEx Ground®",
"serviceCode": "fedex_ground",
"shipmentCost": 8.25,
"otherCost": 0.33
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/shipments/voidlabel": {
"post": {
"tags": [
"Shipments"
],
"summary": "Void Label",
"description": "Voids the specified label by shipmentId. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``shipmentId`` | number, required | ID of the shipment to void.",
"operationId": "VoidLabel",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoidLabelrequest"
},
"example": "{\n \"shipmentId\": 12345\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoidLabelresponse"
},
"example": {
"approved": true,
"message": "Label voided successfully"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores/{storeId}": {
"get": {
"tags": [
"Stores"
],
"summary": "Get Store",
"description": "",
"operationId": "GetStore",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "A unique ID generated by ShipStation and assigned to each store.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"Authorization": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "< Enter your Basic Authorization string here >"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStoreresponse"
},
"example": {
"storeId": 12345,
"storeName": "WooCommerce Store",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation-test.wpengine.com",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-12-16T17:47:05.457",
"lastRefreshAttempt": "2014-12-16T09:47:05.457",
"createDate": "2014-11-06T15:21:13.223",
"modifyDate": "2014-11-10T08:02:19.117",
"autoRefresh": true,
"statusMappings": [
{
"orderStatus": "awaiting_payment",
"statusKey": "Pending"
},
{
"orderStatus": "awaiting_shipment",
"statusKey": "Processing"
},
{
"orderStatus": "shipped",
"statusKey": "Completed"
},
{
"orderStatus": "cancelled",
"statusKey": "Cancelled"
},
{
"orderStatus": "on_hold",
"statusKey": "On-hold"
}
]
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
},
"put": {
"tags": [
"Stores"
],
"summary": "Update Store",
"description": "Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.",
"operationId": "UpdateStore",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "A unique ID generated by ShipStation and assigned to each store.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStorerequest"
},
"example": "{\n \"storeId\": 12345,\n \"storeName\": \"WooCommerce Store\",\n \"marketplaceId\": 36,\n \"marketplaceName\": \"WooCommerce\",\n \"accountName\": null,\n \"email\": null,\n \"integrationUrl\": \"http://shipstation-test.wpengine.com\",\n \"active\": true,\n \"companyName\": \"\",\n \"phone\": \"\",\n \"publicEmail\": \"\",\n \"website\": \"\",\n \"refreshDate\": \"2014-12-16T17:47:05.457\",\n \"lastRefreshAttempt\": \"2014-12-16T09:47:05.457\",\n \"createDate\": \"2014-11-06T15:21:13.223\",\n \"modifyDate\": \"2014-11-10T08:02:19.117\",\n \"autoRefresh\": true,\n \"statusMappings\": [\n {\n \"orderStatus\": \"awaiting_payment\",\n \"statusKey\": \"Pending\"\n },\n {\n \"orderStatus\": \"awaiting_shipment\",\n \"statusKey\": \"Processing\"\n },\n {\n \"orderStatus\": \"shipped\",\n \"statusKey\": \"Completed\"\n },\n {\n \"orderStatus\": \"cancelled\",\n \"statusKey\": \"Cancelled\"\n },\n {\n \"orderStatus\": \"on_hold\",\n \"statusKey\": \"On-hold\"\n }\n ]\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
"Authorization": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "< Enter your Basic Authorization string here >"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStoreresponse"
},
"example": {
"storeId": 12345,
"storeName": "WooCommerce Store",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation-test.wpengine.com",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-12-16T17:47:05.457",
"lastRefreshAttempt": "2014-12-16T09:47:05.457",
"createDate": "2014-11-06T15:21:13.223",
"modifyDate": "2014-11-10T08:02:19.117",
"autoRefresh": true,
"statusMappings": [
{
"orderStatus": "awaiting_payment",
"statusKey": "Pending"
},
{
"orderStatus": "awaiting_shipment",
"statusKey": "Processing"
},
{
"orderStatus": "shipped",
"statusKey": "Completed"
},
{
"orderStatus": "cancelled",
"statusKey": "Cancelled"
},
{
"orderStatus": "on_hold",
"statusKey": "On-hold"
}
]
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores/getrefreshstatus?storeId={storeId}": {
"get": {
"tags": [
"Stores"
],
"summary": "Get Store Refresh Status",
"description": "Retrieves the refresh status of a given store.",
"operationId": "GetStoreRefreshStatus",
"parameters": [
{
"name": "storeId",
"in": "path",
"description": "Specifies the store whose status will be retrieved.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStoreRefreshStatusresponse"
},
"example": {
"storeId": 12345,
"refreshStatusId": 2,
"refreshStatus": "Updating orders",
"lastRefreshAttempt": "8-13-2014",
"refreshDate": "8-13-2014"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores/refreshstore?storeId={storeId}&refreshDate={refreshDate}": {
"post": {
"tags": [
"Stores"
],
"summary": "Refresh Store",
"description": "Initiates a store refresh.",
"operationId": "RefreshStore",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "storeId",
"in": "path",
"description": "Specifies the store which will get refreshed. If the storeId is not specified, a store refresh will be initiated for all refreshable stores on that account.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "refreshDate",
"in": "path",
"description": "Specifies the starting date for new order imports. If the refreshDate is not specified, ShipStation will use the last recorded refreshDate for that store.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshStorerequest"
},
"example": "{\n \"storeId\": 12345,\n \"refreshDate\": \"12-08-2014\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshStoreresponse"
},
"example": {
"success": true,
"message": "A store refresh has been initiated for Store ID 12345"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores?showInactive={showInactive}&marketplaceId={marketplaceId}": {
"get": {
"tags": [
"Stores"
],
"summary": "List Stores",
"description": "Retrieve the list of installed stores on the account.",
"operationId": "ListStores",
"parameters": [
{
"name": "showInactive",
"in": "path",
"description": "Determines whether inactive stores will be returned in the list of stores.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "boolean",
"example": false
}
},
{
"name": "marketplaceId",
"in": "path",
"description": "Returns stores of this marketplace type.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListStoresresponse"
},
"description": ""
},
"example": [
{
"storeId": 22766,
"storeName": "ShipStation Manual Store",
"marketplaceId": 0,
"marketplaceName": "ShipStation",
"accountName": null,
"email": null,
"integrationUrl": null,
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "testemail@email.com",
"website": "",
"refreshDate": "2014-12-03T11:46:11.283",
"lastRefreshAttempt": "2014-12-03T11:46:53.433",
"createDate": "2014-07-25T11:05:55.307",
"modifyDate": "2014-11-12T08:45:20.55",
"autoRefresh": false
},
{
"storeId": 25748,
"storeName": "Ashley's Test WooCommerce",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation.wpengine.com/",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-11-26T22:28:14.07",
"lastRefreshAttempt": "2014-11-26T14:28:14.07",
"createDate": "2014-11-10T08:53:48.077",
"modifyDate": "2014-12-03T14:53:50.557",
"autoRefresh": true
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores/marketplaces": {
"get": {
"tags": [
"Stores"
],
"summary": "List Marketplaces",
"description": "Lists the marketplaces that can be integrated with ShipStation.",
"operationId": "ListMarketplaces",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListMarketplacesresponse"
},
"description": ""
},
"example": [
{
"name": "3DCart",
"marketplaceId": 23,
"canRefresh": true,
"supportsCustomMappings": true,
"supportsCustomStatuses": false,
"canConfirmShipments": true
},
{
"name": "Amazon",
"marketplaceId": 2,
"canRefresh": true,
"supportsCustomMappings": true,
"supportsCustomStatuses": false,
"canConfirmShipments": true
},
{
"name": "Amazon CA",
"marketplaceId": 32,
"canRefresh": true,
"supportsCustomMappings": true,
"supportsCustomStatuses": false,
"canConfirmShipments": true
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores/deactivate": {
"post": {
"tags": [
"Stores"
],
"summary": "Deactivate Store",
"description": "Deactivates the specified store.\nThe body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``storeId`` | number, required | ID of the store to deactivate.",
"operationId": "DeactivateStore",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeactivateStorerequest"
},
"example": "{\n \"storeId\": \"12345\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeactivateStoreresponse"
},
"example": {
"success": "true",
"message": "The requested store has been reactivated."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/stores/reactivate": {
"post": {
"tags": [
"Stores"
],
"summary": "Reactivate Store",
"description": "Reactivates the specified store. Note: stores are active by default\nThe body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``storeId`` | number, required | ID of the store to reactivate.",
"operationId": "ReactivateStore",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReactivateStorerequest"
},
"example": "{\n \"storeId\": \"12345\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReactivateStoreresponse"
},
"example": {
"success": "true",
"message": "The requested store has been reactivated."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/users?showInactive={showInactive}": {
"get": {
"tags": [
"Users"
],
"summary": "List Users",
"description": "",
"operationId": "ListUsers",
"parameters": [
{
"name": "showInactive",
"in": "path",
"description": "Determines whether inactive users will be returned in the response.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "boolean",
"example": false
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"Authorization": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "< Enter your Basic Authorization string here >"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListUsersresponse"
},
"example": {
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"userName": "SS-user1",
"name": "Shipping Employee 1"
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/warehouses/{warehouseId}": {
"get": {
"tags": [
"Warehouses"
],
"summary": "Get Warehouse",
"description": "Returns a list of active Ship From Locations (formerly known as warehouses) on the ShipStation account. Warehouses are now called \"Ship From Locations\" in the UI.",
"operationId": "GetWarehouse",
"parameters": [
{
"name": "warehouseId",
"in": "path",
"description": "A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"Authorization": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "< Enter your Basic Authorization string here >"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetWarehouseresponse"
},
"example": {
"warehouseId": 12345,
"warehouseName": "API Ship From Location",
"originAddress": {
"name": "API Warehouse",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": true,
"addressVerified": null
},
"returnAddress": {
"name": "API Ship From Location",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": null,
"addressVerified": null
},
"createDate": "2015-07-02T08:38:31.487",
"isDefault": true
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
},
"put": {
"tags": [
"Warehouses"
],
"summary": "Update Warehouse",
"description": "Updates an existing Ship From Location (formerly known as warehouse). This call does not currently support partial updates. The entire resource must be provided in the body of the request. If a \"returnAddress\" object is not specified, your \"originAddress\" will be used as your \"returnAddress\".",
"operationId": "UpdateWarehouse",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "warehouseId",
"in": "path",
"description": "A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345678
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWarehouserequest"
},
"example": "{\n \"warehouseId\": 12345,\n \"warehouseName\": \"API Ship From Location\",\n \"originAddress\": {\n \"name\": \"API Warehouse\",\n \"company\": \"ShipStation\",\n \"street1\": \"2815 Exposition Blvd\",\n \"street2\": null,\n \"street3\": null,\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postalCode\": \"78703\",\n \"country\": \"US\",\n \"phone\": \"512-555-5555\",\n \"residential\": true,\n \"addressVerified\": null\n },\n \"returnAddress\": {\n \"name\": \"API Ship From Location\",\n \"company\": \"ShipStation\",\n \"street1\": \"2815 Exposition Blvd\",\n \"street2\": null,\n \"street3\": null,\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"postalCode\": \"78703\",\n \"country\": \"US\",\n \"phone\": \"512-555-5555\",\n \"residential\": null,\n \"addressVerified\": null\n },\n \"createDate\": \"2015-07-02T08:38:31.4870000\",\n \"isDefault\": true\n }"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
"Authorization": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "< Enter your Basic Authorization string here >"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWarehouseresponse"
},
"example": {
"warehouseId": 12345,
"warehouseName": "API Ship From Location",
"originAddress": {
"name": "API Warehouse",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": true,
"addressVerified": null
},
"returnAddress": {
"name": "API Ship From Location",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": null,
"addressVerified": null
},
"createDate": "2015-07-02T08:38:31.487",
"isDefault": true
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
},
"delete": {
"tags": [
"Warehouses"
],
"summary": "Delete Warehouse",
"description": "Removes warehouse from ShipStation's UI. Note this is a \"soft\" delete action so the warehouse will still exist in the database, but will be set to inactive",
"operationId": "DeleteWarehouse",
"parameters": [
{
"name": "warehouseId",
"in": "path",
"description": "A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345678
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteWarehouseresponse"
},
"example": {
"success": true,
"message": "The requested warehouse has been deleted."
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/warehouses/createwarehouse": {
"post": {
"tags": [
"Warehouses"
],
"summary": "Create Warehouse",
"description": "Adds a Ship From Location (formerly known as warehouse) to your account. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``warehouseName`` | string, optional | Name of Ship From Location.\n ``originAddress`` | Address, required | The origin address. Shipping rates will be calculated from this address. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``returnAddress`` | Address, optional | The return address. If a \"returnAddress\" is not specified, your \"originAddress\" will be used as your \"returnAddress\". Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``isDefault`` | boolean, optional | Specifies whether or not this will be your default Ship From Location.",
"operationId": "CreateWarehouse",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWarehouserequest"
},
"example": "{\n \"warehouseName\": \"New Ship From Location\",\n \"originAddress\": {\n \"name\": \"NM Warehouse\",\n \"company\": \"White Sands Co.\",\n \"street1\": \"4704 Arabela Dr.\",\n \"street2\": null,\n \"street3\": null,\n \"city\": \"Las Cruces\",\n \"state\": \"NM\",\n \"postalCode\": \"80012\",\n \"country\": \"US\",\n \"phone\": \"512-111-2222\",\n \"residential\": true\n },\n \"returnAddress\": null,\n \"isDefault\": false\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWarehouseresponse"
},
"example": {
"warehouseId": 17977,
"warehouseName": "New Ship From Location",
"originAddress": {
"name": "NM Warehouse",
"company": "White Sands Co",
"street1": "4704 Arabela Dr.",
"street2": "",
"street3": "",
"city": "Las Cruces",
"state": "NM",
"postalCode": "88012",
"country": "US",
"phone": "512-111-2222",
"residential": true
},
"returnAddress": {
"name": "NM Warehouse",
"company": "White Sands Co",
"street1": "4704 Arabela Dr.",
"street2": "",
"street3": "",
"city": "Las Cruces",
"state": "NM",
"postalCode": "88012",
"country": "US",
"phone": "512-111-2222",
"residential": null
},
"createDate": "2014-10-21T08:11:43.88",
"isDefault": false
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/warehouses": {
"get": {
"tags": [
"Warehouses"
],
"summary": "List Warehouses",
"description": "Retrieves a list of your Ship From Locations (formerly known as warehouses).",
"operationId": "ListWarehouses",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListWarehousesresponse"
},
"description": ""
},
"example": [
{
"warehouseId": 17977,
"warehouseName": "Main warehouse",
"originAddress": {
"name": "Spring warehouse",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": false
},
"returnAddress": {
"name": "Chicago House",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": null
},
"createDate": "2014-10-21T08:11:43.88",
"isDefault": true
},
{
"warehouseId": 14265,
"warehouseName": "Austin",
"originAddress": {
"name": "Austin",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": "",
"street3": "",
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "5124445555",
"residential": false
},
"returnAddress": {
"name": "ShipStation",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": "",
"street3": "",
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "5124445555",
"residential": null
},
"createDate": "2014-05-27T09:54:29.96",
"isDefault": false
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/webhooks": {
"get": {
"tags": [
"Webhooks"
],
"summary": "List Webhooks",
"description": "Retrieves a list of registered webhooks for the account",
"operationId": "ListWebhooks",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListWebhooksresponse"
},
"example": {
"webhooks": [
{
"IsLabelAPIHook": false,
"WebHookID": 123,
"SellerID": 100000,
"StoreID": 12345,
"HookType": "ITEM_ORDER_NOTIFY",
"MessageFormat": "Json",
"Url": "http://example.endpoint/orders",
"Name": "My Order Webhook",
"BulkCopyBatchID": null,
"BulkCopyRecordID": null,
"Active": true,
"WebhookLogs": [],
"Seller": null,
"Store": null
},
{
"IsLabelAPIHook": false,
"WebHookID": 456,
"SellerID": 100000,
"StoreID": 98765,
"HookType": "SHIP_NOTIFY",
"MessageFormat": "Json",
"Url": "https://example.endpoint/shipment",
"Name": "My Shipment Webhook",
"BulkCopyBatchID": null,
"BulkCopyRecordID": null,
"Active": true,
"WebhookLogs": [],
"Seller": null,
"Store": null
}
]
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/webhooks/subscribe": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Subscribe to Webhook",
"description": "Subscribes to a specific type of webhook. If a ``store_id`` is passed in, the webhooks will only be triggered for that specific ``store_id``.\nThe ``event`` type that is passed in will determine what type of webhooks will be sent.\nWebhooks can be viewed & edited via the ShipStation Application under Integrations in the [**Account Settings**](https://ss.shipstation.com/#/settings/integrations).\nNOTE: Webhooks will be sent to the URL specified in the ``target_url``. The HTTP request will be sent via POST and will contain a [**webhook JSON object**](https://www.shipstation.com/developer-api/#/reference/model-webhook) in the body.\nThe body of this request to subscribe has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``target_url`` | string, required | The URL to send the webhooks to\n``event`` | string, required | The type of webhook to subscribe to. Must contain one of the following values: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY\n``store_id`` | int, optional | If passed in, the webhooks will only be triggered for this ``store_id``\n``friendly_name`` | string, optional | Display name for the webhook",
"operationId": "SubscribeToWebhook",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscribetoWebhookrequest"
},
"example": "{\n \"target_url\": \"http://someexamplewebhookurl.com/neworder\",\n \"event\": \"ORDER_NOTIFY\",\n \"store_id\": null,\n \"friendly_name\": \"My Webhook\"\n}"
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscribetoWebhookresponse"
},
"example": {
"id": 123456
}
}
}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
},
"/webhooks/{webhookId}": {
"delete": {
"tags": [
"Webhooks"
],
"summary": "Unsubscribe to Webhook",
"description": "Unsubscribes from a certain webhook.",
"operationId": "UnsubscribeToWebhook",
"parameters": [
{
"name": "webhookId",
"in": "path",
"description": "A unique ID generated by ShipStation and assigned to each webhook.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "number",
"format": "double",
"example": 12345
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"deprecated": false,
"security": [
{
"httpBasic": []
}
]
}
}
},
"components": {
"schemas": {
"RegisterAccountrequest": {
"title": "RegisterAccountrequest",
"required": [
"firstName",
"lastName",
"email",
"password",
"shippingOriginCountryCode",
"companyName",
"addr1",
"addr2",
"city",
"state",
"zip",
"countryCode",
"phone"
],
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"shippingOriginCountryCode": {
"type": "string"
},
"companyName": {
"type": "string"
},
"addr1": {
"type": "string"
},
"addr2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"phone": {
"type": "string"
}
},
"example": {
"firstName": "John",
"lastName": "Smith",
"email": "jsmithtest@gmail.com",
"password": "testpw1234",
"shippingOriginCountryCode": "US",
"companyName": "Droid Repair LLC",
"addr1": "542 Midichlorian Rd.",
"addr2": "",
"city": "Austin",
"state": "TX",
"zip": "78703",
"countryCode": "US",
"phone": "5124111234"
}
},
"RegisterAccountresponse": {
"title": "RegisterAccountresponse",
"required": [
"message",
"sellerId",
"success",
"apiKey",
"apiSecret"
],
"type": "object",
"properties": {
"message": {
"type": "string"
},
"sellerId": {
"type": "integer",
"format": "int32"
},
"success": {
"type": "boolean"
},
"apiKey": {
"type": "string"
},
"apiSecret": {
"type": "string"
}
},
"example": {
"message": "ShipStation account created.",
"sellerId": 123456,
"success": true,
"apiKey": "abcdt9845hjmgfklj3498gkljdkuyekl",
"apiSecret": "1234iou983lkj8mnxgfwu509hkhdy7u3"
}
},
"ListTagsresponse": {
"title": "ListTagsresponse",
"required": [
"tagId",
"name",
"color"
],
"type": "object",
"properties": {
"tagId": {
"type": "integer",
"format": "int32",
"example": 8362
},
"name": {
"type": "string",
"example": "Backorder"
},
"color": {
"type": "string",
"example": "#800080"
}
},
"example": {
"tagId": 8362,
"name": "Backorder",
"color": "#800080"
}
},
"ListCarriersresponse": {
"title": "ListCarriersresponse",
"required": [
"name",
"code",
"accountNumber",
"requiresFundedAccount",
"balance",
"shippingProviderId",
"primary"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Stamps.com"
},
"code": {
"type": "string",
"example": "stamps_com"
},
"accountNumber": {
"type": "string",
"example": "SS123"
},
"requiresFundedAccount": {
"type": "boolean",
"example": true
},
"balance": {
"type": "number",
"example": 24.27
},
"nickname": {
"type": "string",
"nullable": true
},
"shippingProviderId": {
"type": "integer",
"format": "int32",
"example": 12345
},
"primary": {
"type": "boolean",
"example": true
}
},
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": "null",
"shippingProviderId": 12345,
"primary": true
}
},
"GetCarrierresponse": {
"title": "GetCarrierresponse",
"required": [
"name",
"code",
"accountNumber",
"requiresFundedAccount",
"balance",
"shippingProviderId",
"primary"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"requiresFundedAccount": {
"type": "boolean"
},
"balance": {
"type": "number"
},
"nickname": {
"type": "string",
"nullable": true
},
"shippingProviderId": {
"type": "integer",
"format": "int32"
},
"primary": {
"type": "boolean"
}
},
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": null,
"shippingProviderId": 12345,
"primary": true
}
},
"AddFundsrequest": {
"title": "AddFundsrequest",
"required": [
"carrierCode",
"amount"
],
"type": "object",
"properties": {
"carrierCode": {
"type": "string"
},
"amount": {
"type": "number"
}
},
"example": {
"carrierCode": "fedex",
"amount": 20.0
}
},
"AddFundsresponse": {
"title": "AddFundsresponse",
"required": [
"name",
"code",
"accountNumber",
"requiresFundedAccount",
"balance"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"requiresFundedAccount": {
"type": "boolean"
},
"balance": {
"type": "number"
}
},
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.14
}
},
"ListPackagesresponse": {
"title": "ListPackagesresponse",
"required": [
"carrierCode",
"code",
"name",
"domestic",
"international"
],
"type": "object",
"properties": {
"carrierCode": {
"type": "string",
"example": "express_1"
},
"code": {
"type": "string",
"example": "cubic"
},
"name": {
"type": "string",
"example": "Cubic"
},
"domestic": {
"type": "boolean",
"example": true
},
"international": {
"type": "boolean",
"example": false
}
},
"example": {
"carrierCode": "express_1",
"code": "cubic",
"name": "Cubic",
"domestic": true,
"international": false
}
},
"ListServicesresponse": {
"title": "ListServicesresponse",
"required": [
"carrierCode",
"code",
"name",
"domestic",
"international"
],
"type": "object",
"properties": {
"carrierCode": {
"type": "string",
"example": "fedex"
},
"code": {
"type": "string",
"example": "fedex_ground"
},
"name": {
"type": "string",
"example": "FedEx Ground®"
},
"domestic": {
"type": "boolean",
"example": true
},
"international": {
"type": "boolean",
"example": false
}
},
"example": {
"carrierCode": "fedex",
"code": "fedex_ground",
"name": "FedEx Ground®",
"domestic": true,
"international": false
}
},
"GetCustomerresponse": {
"title": "GetCustomerresponse",
"required": [
"customerId",
"createDate",
"modifyDate",
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"countryCode",
"phone",
"email",
"addressVerified",
"marketplaceUsernames",
"tags"
],
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"addressVerified": {
"type": "string"
},
"marketplaceUsernames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarketplaceUsername"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"description": ""
}
},
"example": {
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.19\"",
"modifyDate": "\"2014-11-18T10:33:01.19\"",
"name": "Cam Newton",
"company": "Test Company",
"street1": "123 War Eagle Lane",
"street2": "",
"city": "Auburn",
"state": "AL",
"postalCode": "36830",
"countryCode": "US",
"phone": "555-555-5555",
"email": "supermancam@example.com",
"addressVerified": "Verified",
"marketplaceUsernames": [
{
"customerUserId": 67195020,
"customerId": 12345678,
"createDate": "\"2015-04-27T12:35:03.83\"",
"modifyDate": "\"2015-05-14T08:16:15.27\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "camtheman@gmail.com"
},
{
"customerUserId": 37568588,
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.197\"",
"modifyDate": "\"2014-11-18T10:33:01.197\"",
"marketplaceId": 36,
"marketplace": "WooCommerce",
"username": "supercam@example.com"
},
{
"customerUserId": 46038940,
"customerId": 12345678,
"createDate": "null",
"modifyDate": "null",
"marketplaceId": 67,
"marketplace": "TradeGecko",
"username": "camtheman@gmail.com"
}
],
"tags": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
]
}
},
"MarketplaceUsername": {
"title": "MarketplaceUsername",
"required": [
"customerUserId",
"customerId",
"createDate",
"modifyDate",
"marketplaceId",
"marketplace",
"username"
],
"type": "object",
"properties": {
"customerUserId": {
"type": "integer",
"format": "int32",
"example": 67195020
},
"customerId": {
"type": "integer",
"format": "int32",
"example": 12345678
},
"createDate": {
"type": "string",
"example": "4/27/2015 12:35:03 PM"
},
"modifyDate": {
"type": "string",
"example": "5/14/2015 8:16:15 AM"
},
"marketplaceId": {
"type": "integer",
"format": "int32",
"example": 0
},
"marketplace": {
"type": "string",
"example": "ShipStation"
},
"username": {
"type": "string",
"example": "camtheman@gmail.com"
}
},
"example": {
"customerUserId": 67195020,
"customerId": 12345678,
"createDate": "\"2015-04-27T12:35:03.83\"",
"modifyDate": "\"2015-05-14T08:16:15.27\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "camtheman@gmail.com"
}
},
"Tag": {
"title": "Tag",
"required": [
"tagId",
"name"
],
"type": "object",
"properties": {
"tagId": {
"type": "integer",
"format": "int32",
"example": 1234
},
"name": {
"type": "string",
"example": "Expedited"
}
},
"example": {
"tagId": 1234,
"name": "Expedited"
}
},
"sortBy": {
"title": "sortBy",
"enum": [
"Name",
"ModifyDate",
"CreateDate"
],
"type": "string",
"example": "Name"
},
"sortDir": {
"title": "sortDir",
"enum": [
"ASC",
"DESC"
],
"type": "string",
"example": "ASC"
},
"ListCustomersresponse": {
"title": "ListCustomersresponse",
"required": [
"customers",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"customers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"example": {
"customers": [
{
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.19\"",
"modifyDate": "\"2014-11-18T10:33:01.19\"",
"name": "Cam Newton",
"company": "Test Company",
"street1": "123 War Eagle Lane",
"street2": "",
"city": "Auburn",
"state": "AL",
"postalCode": "36830",
"countryCode": "US",
"phone": "555-555-5555",
"email": "supermancam@example.com",
"addressVerified": "Verified",
"marketplaceUsernames": [
{
"customerUserId": 67195020,
"customerId": 12345678,
"createDate": "\"2015-04-27T12:35:03.83\"",
"modifyDate": "\"2015-05-14T08:16:15.27\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "camtheman@gmail.com"
},
{
"customerUserId": 37568588,
"customerId": 12345678,
"createDate": "\"2014-11-18T10:33:01.197\"",
"modifyDate": "\"2014-11-18T10:33:01.197\"",
"marketplaceId": 36,
"marketplace": "WooCommerce",
"username": "supercam@example.com"
},
{
"customerUserId": 46038940,
"customerId": 12345678,
"createDate": "null",
"modifyDate": "null",
"marketplaceId": 67,
"marketplace": "TradeGecko",
"username": "camtheman@gmail.com"
}
],
"tags": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
]
},
{
"customerId": 87654321,
"createDate": "\"2015-06-21T12:48:07.54\"",
"name": "Bo Jackson",
"company": "Test Company",
"street1": "456 Heisman Ave",
"street2": "",
"city": "Auburn",
"state": "AL",
"postalCode": "36830",
"countryCode": "US",
"phone": "555-555-5555",
"email": "boknows@example.com",
"addressVerified": "Verified",
"marketplaceUsernames": [
{
"customerUserId": 77215410,
"customerId": 87654321,
"createDate": "\"2015-08-27T14:36:05.75\"",
"modifyDate": "\"2015-09-01T09:18:25.31\"",
"marketplaceId": 0,
"marketplace": "ShipStation",
"username": "boknows@gmail.com"
},
{
"customerUserId": 43759100,
"customerId": 87654321,
"createDate": "\"2015-07-05T11:38:01.197\"",
"modifyDate": "\"2015-07-05T11:38:01.197\"",
"marketplaceId": 36,
"marketplace": "WooCommerce",
"username": "boknows@example.com"
},
{
"customerUserId": 81565241,
"customerId": 87654321,
"createDate": "null",
"modifyDate": "null",
"marketplaceId": 67,
"marketplace": "TradeGecko",
"username": "bo@gmail.com"
}
],
"tags": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
]
}
],
"total": 2,
"page": 1,
"pages": 1
}
},
"Customer": {
"title": "Customer",
"required": [
"customerId",
"createDate",
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"countryCode",
"phone",
"email",
"addressVerified",
"marketplaceUsernames",
"tags"
],
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int32",
"example": 12345678
},
"createDate": {
"type": "string",
"example": "11/18/2014 10:33:01 AM"
},
"modifyDate": {
"type": "string",
"example": "11/18/2014 10:33:01 AM"
},
"name": {
"type": "string",
"example": "Cam Newton"
},
"company": {
"type": "string",
"example": "Test Company"
},
"street1": {
"type": "string",
"example": "123 War Eagle Lane"
},
"street2": {
"type": "string"
},
"city": {
"type": "string",
"example": "Auburn"
},
"state": {
"type": "string",
"example": "AL"
},
"postalCode": {
"type": "string",
"example": "36830"
},
"countryCode": {
"type": "string",
"example": "US"
},
"phone": {
"type": "string",
"example": "555-555-5555"
},
"email": {
"type": "string",
"example": "supermancam@example.com"
},
"addressVerified": {
"type": "string",
"example": "Verified"
},
"marketplaceUsernames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MarketplaceUsername"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"description": ""
}
}
},
"ListFulfillmentsw/oparametersresponse": {
"title": "ListFulfillmentsw/oparametersresponse",
"required": [
"fulfillments",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Fulfillment"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"example": {
"fulfillments": [
{
"fulfillmentId": 33974374,
"orderId": 191759016,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "783408231234",
"createDate": "2016-06-07T08:50:50.067",
"shipDate": "2016-06-07T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "USPS",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
},
{
"fulfillmentId": 246310,
"orderId": 193699927,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "664756278745",
"createDate": "2016-06-08T12:54:53.347",
"shipDate": "2016-06-08T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "FedEx",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
}
],
"total": 2,
"page": 1,
"pages": 0
}
},
"Fulfillment": {
"title": "Fulfillment",
"required": [
"fulfillmentId",
"orderId",
"orderNumber",
"userId",
"customerEmail",
"trackingNumber",
"createDate",
"shipDate",
"carrierCode",
"fulfillmentFee",
"voidRequested",
"voided",
"marketplaceNotified",
"shipTo"
],
"type": "object",
"properties": {
"fulfillmentId": {
"type": "integer",
"format": "int32",
"example": 33974374
},
"orderId": {
"type": "integer",
"format": "int32",
"example": 191759016
},
"orderNumber": {
"type": "string",
"example": "101"
},
"userId": {
"type": "string",
"example": "c9f06d74-95de-4263-9b04-e87095cababf"
},
"customerEmail": {
"type": "string",
"example": "apisupport@shipstation.com"
},
"trackingNumber": {
"type": "string",
"example": "783408231234"
},
"createDate": {
"type": "string",
"example": "6/7/2016 8:50:50 AM"
},
"shipDate": {
"type": "string",
"example": "6/7/2016 12:00:00 AM"
},
"voidDate": {
"type": "string",
"nullable": true
},
"deliveryDate": {
"type": "string",
"nullable": true
},
"carrierCode": {
"type": "string",
"example": "USPS"
},
"fulfillmentProviderCode": {
"type": "string",
"nullable": true
},
"fulfillmentServiceCode": {
"type": "string",
"nullable": true
},
"fulfillmentFee": {
"type": "integer",
"format": "int32",
"example": 0
},
"voidRequested": {
"type": "boolean",
"example": false
},
"voided": {
"type": "boolean",
"example": false
},
"marketplaceNotified": {
"type": "boolean",
"example": true
},
"notifyErrorMessage": {
"type": "string",
"nullable": true
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo"
}
}
},
"ShipTo": {
"title": "ShipTo",
"required": [
"name",
"street1",
"city",
"state",
"postalCode",
"country",
"phone"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Yoda"
},
"company": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"example": "3800 N Lamar Blvd # 220"
},
"street2": {
"type": "string",
"nullable": true
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"example": "AUSTIN"
},
"state": {
"type": "string",
"example": "TX"
},
"postalCode": {
"type": "string",
"example": "78756"
},
"country": {
"type": "string",
"example": "US"
},
"phone": {
"type": "string",
"example": "512-485-4282"
},
"residential": {
"type": "string",
"nullable": true
},
"addressVerified": {
"type": "string",
"nullable": true
}
},
"example": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
},
"sortBy1": {
"title": "sortBy1",
"enum": [
"ShipDate",
"CreateDate"
],
"type": "string",
"example": "ShipDate"
},
"ListFulfillmentswithparametersresponse": {
"title": "ListFulfillmentswithparametersresponse",
"required": [
"fulfillments",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Fulfillment"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"example": {
"fulfillments": [
{
"fulfillmentId": 33974374,
"orderId": 191759016,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "783408231234",
"createDate": "2016-06-07T08:50:50.067",
"shipDate": "2016-06-07T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "USPS",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
},
{
"fulfillmentId": 246310,
"orderId": 193699927,
"orderNumber": "101",
"userId": "c9f06d74-95de-4263-9b04-e87095cababf",
"customerEmail": "apisupport@shipstation.com",
"trackingNumber": "664756278745",
"createDate": "2016-06-08T12:54:53.347",
"shipDate": "2016-06-08T00:00:00",
"voidDate": null,
"deliveryDate": null,
"carrierCode": "FedEx",
"fulfillmentProviderCode": null,
"fulfillmentServiceCode": null,
"fulfillmentFee": 0,
"voidRequested": false,
"voided": false,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": null,
"street1": "3800 N Lamar Blvd # 220",
"street2": null,
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78756",
"country": "US",
"phone": "512-485-4282",
"residential": null,
"addressVerified": null
}
}
],
"total": 2,
"page": 1,
"pages": 0
}
},
"GetOrderresponse": {
"title": "GetOrderresponse",
"required": [
"orderId",
"orderNumber",
"orderKey",
"orderDate",
"createDate",
"modifyDate",
"paymentDate",
"shipByDate",
"orderStatus",
"customerId",
"customerUsername",
"customerEmail",
"billTo",
"shipTo",
"items",
"orderTotal",
"amountPaid",
"taxAmount",
"shippingAmount",
"customerNotes",
"internalNotes",
"gift",
"giftMessage",
"paymentMethod",
"requestedShippingService",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"insuranceOptions",
"internationalOptions",
"advancedOptions",
"externallyFulfilled"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"orderNumber": {
"type": "string"
},
"orderKey": {
"type": "string"
},
"orderDate": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"shipByDate": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"customerId": {
"type": "integer",
"format": "int32"
},
"customerUsername": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"billTo": {
"$ref": "#/components/schemas/BillTo"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo2"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
},
"description": ""
},
"orderTotal": {
"type": "number"
},
"amountPaid": {
"type": "number"
},
"taxAmount": {
"type": "integer",
"format": "int32"
},
"shippingAmount": {
"type": "integer",
"format": "int32"
},
"customerNotes": {
"type": "string"
},
"internalNotes": {
"type": "string"
},
"gift": {
"type": "boolean"
},
"giftMessage": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"requestedShippingService": {
"type": "string"
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"holdUntilDate": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/components/schemas/InternationalOptions"
},
"advancedOptions": {
"$ref": "#/components/schemas/AdvancedOptions"
},
"tagIds": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"externallyFulfilled": {
"type": "boolean"
},
"externallyFulfilledBy": {
"type": "string",
"nullable": true
}
}
},
"BillTo": {
"title": "BillTo",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"residential": {
"type": "string",
"nullable": true
},
"addressVerified": {
"type": "string",
"nullable": true
}
},
"example": {
"name": "Sherlock Holmes",
"company": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"state": null,
"postalCode": null,
"country": null,
"phone": null,
"residential": null,
"addressVerified": null
}
},
"ShipTo2": {
"title": "ShipTo2",
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"phone",
"residential",
"addressVerified"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "boolean"
},
"addressVerified": {
"type": "string"
}
},
"example": {
"name": "The President",
"company": "US Govt",
"street1": "1600 Pennsylvania Ave",
"street2": "Oval Office",
"street3": null,
"city": "Washington",
"state": "DC",
"postalCode": "20500",
"country": "US",
"phone": "555-555-5555",
"residential": false,
"addressVerified": "Address validation warning"
}
},
"Item": {
"title": "Item",
"required": [
"orderItemId",
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"warehouseLocation",
"options",
"productId",
"adjustment",
"createDate",
"modifyDate"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"format": "int32",
"example": 128836912
},
"lineItemKey": {
"type": "string",
"example": "vd08-MSLbtx"
},
"sku": {
"type": "string",
"example": "ABC123"
},
"name": {
"type": "string",
"example": "Test item #1"
},
"imageUrl": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 2
},
"unitPrice": {
"type": "number",
"example": 99.99
},
"taxAmount": {
"type": "string",
"nullable": true
},
"shippingAmount": {
"type": "string",
"nullable": true
},
"warehouseLocation": {
"type": "string",
"example": "Aisle 1, Bin 7"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
},
"description": ""
},
"productId": {
"type": "integer",
"format": "int32",
"example": 7239919
},
"fulfillmentSku": {
"type": "string",
"nullable": true
},
"adjustment": {
"type": "boolean",
"example": false
},
"upc": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"example": "7/16/2015 2:00:34 PM"
},
"modifyDate": {
"type": "string",
"example": "7/16/2015 2:00:34 PM"
}
}
},
"Weight": {
"title": "Weight",
"required": [
"value",
"units"
],
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 24
},
"units": {
"type": "string",
"example": "ounces"
}
},
"example": {
"value": 24,
"units": "ounces"
}
},
"Option": {
"title": "Option",
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Size"
},
"value": {
"type": "string",
"example": "Large"
}
},
"example": {
"name": "Size",
"value": "Large"
}
},
"Dimensions": {
"title": "Dimensions",
"required": [
"units",
"length",
"width",
"height"
],
"type": "object",
"properties": {
"units": {
"type": "string"
},
"length": {
"type": "integer",
"format": "int32"
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
}
},
"example": {
"units": "inches",
"length": 7,
"width": 5,
"height": 6
}
},
"InsuranceOptions": {
"title": "InsuranceOptions",
"required": [
"provider",
"insureShipment",
"insuredValue"
],
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"insureShipment": {
"type": "boolean"
},
"insuredValue": {
"type": "integer",
"format": "int32"
}
},
"example": {
"provider": "carrier",
"insureShipment": true,
"insuredValue": 200
}
},
"InternationalOptions": {
"title": "InternationalOptions",
"type": "object",
"properties": {
"contents": {
"type": "string",
"nullable": true
},
"customsItems": {
"type": "string",
"nullable": true
},
"nonDelivery": {
"type": "string",
"nullable": true
}
},
"example": {
"contents": null,
"customsItems": null,
"nonDelivery": null
}
},
"AdvancedOptions": {
"title": "AdvancedOptions",
"required": [
"warehouseId",
"nonMachinable",
"saturdayDelivery",
"containsAlcohol",
"mergedOrSplit",
"mergedIds",
"storeId",
"customField1",
"customField2",
"customField3",
"source"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"nonMachinable": {
"type": "boolean"
},
"saturdayDelivery": {
"type": "boolean"
},
"containsAlcohol": {
"type": "boolean"
},
"mergedOrSplit": {
"type": "boolean"
},
"mergedIds": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parentId": {
"type": "string",
"nullable": true
},
"storeId": {
"type": "integer",
"format": "int32"
},
"customField1": {
"type": "string"
},
"customField2": {
"type": "string"
},
"customField3": {
"type": "string"
},
"source": {
"type": "string"
},
"billToParty": {
"type": "string",
"nullable": true
},
"billToAccount": {
"type": "string",
"nullable": true
},
"billToPostalCode": {
"type": "string",
"nullable": true
},
"billToCountryCode": {
"type": "string",
"nullable": true
}
},
"example": {
"warehouseId": 98765,
"nonMachinable": false,
"saturdayDelivery": false,
"containsAlcohol": false,
"mergedOrSplit": false,
"mergedIds": [],
"parentId": null,
"storeId": 12345,
"customField1": "Custom data that you can add to an order. See Custom Field #2 & #3 for more info!",
"customField2": "Per UI settings, this information can appear on some carrier's shipping labels. See link below",
"customField3": "https://help.shipstation.com/hc/en-us/articles/206639957",
"source": "Webstore",
"billToParty": null,
"billToAccount": null,
"billToPostalCode": null,
"billToCountryCode": null
}
},
"DeleteOrderresponse": {
"title": "DeleteOrderresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "The requested order has been deleted."
}
},
"AddTagtoOrderrequest": {
"title": "AddTagtoOrderrequest",
"required": [
"orderId",
"tagId"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"tagId": {
"type": "integer",
"format": "int32"
}
},
"example": {
"orderId": 123456,
"tagId": 1234
}
},
"AddTagtoOrderresponse": {
"title": "AddTagtoOrderresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "Tag added successfully."
}
},
"AssignUsertoOrderrequest": {
"title": "AssignUsertoOrderrequest",
"required": [
"orderIds",
"userId"
],
"type": "object",
"properties": {
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": ""
},
"userId": {
"type": "string"
}
},
"example": {
"orderIds": [
123456789,
12345679
],
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa"
}
},
"AssignUsertoOrderresponse": {
"title": "AssignUsertoOrderresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "User assigned successfully."
}
},
"CreateLabelforOrderrequest": {
"title": "CreateLabelforOrderrequest",
"required": [
"orderId",
"carrierCode",
"serviceCode",
"packageCode",
"shipDate",
"weight",
"testLabel"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string",
"nullable": true
},
"shipDate": {
"type": "string"
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"type": "string",
"nullable": true
},
"insuranceOptions": {
"type": "string",
"nullable": true
},
"internationalOptions": {
"type": "string",
"nullable": true
},
"advancedOptions": {
"type": "string",
"nullable": true
},
"testLabel": {
"type": "boolean"
}
},
"example": {
"orderId": 93348442,
"carrierCode": "fedex",
"serviceCode": "fedex_2day",
"packageCode": "package",
"confirmation": null,
"shipDate": "2014-04-03",
"weight": {
"value": 2,
"units": "pounds"
},
"dimensions": null,
"insuranceOptions": null,
"internationalOptions": null,
"advancedOptions": null,
"testLabel": false
}
},
"CreateLabelforOrderresponse": {
"title": "CreateLabelforOrderresponse",
"required": [
"shipmentId",
"shipmentCost",
"insuranceCost",
"trackingNumber",
"labelData"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32"
},
"shipmentCost": {
"type": "number"
},
"insuranceCost": {
"type": "integer",
"format": "int32"
},
"trackingNumber": {
"type": "string"
},
"labelData": {
"type": "string"
},
"formData": {
"type": "string",
"nullable": true
}
},
"example": {
"shipmentId": 72513480,
"shipmentCost": 7.3,
"insuranceCost": 0,
"trackingNumber": "248201115029520",
"labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEJDBV0jCz0LBV1jY0M9I4XkXAX9iDRDBZd8hUAuAEdGC7cKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveFswIDAgMjg4IDQzMl0vUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vQ29udGVudHMgMiAwIFIvUGFyZW50....",
"formData": null
}
},
"Create/UpdateOrderrequest": {
"title": "Create/UpdateOrderrequest",
"required": [
"orderNumber",
"orderKey",
"orderDate",
"paymentDate",
"shipByDate",
"orderStatus",
"customerId",
"customerUsername",
"customerEmail",
"billTo",
"shipTo",
"items",
"amountPaid",
"taxAmount",
"shippingAmount",
"customerNotes",
"internalNotes",
"gift",
"giftMessage",
"paymentMethod",
"requestedShippingService",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"insuranceOptions",
"internationalOptions",
"advancedOptions",
"tagIds"
],
"type": "object",
"properties": {
"orderNumber": {
"type": "string"
},
"orderKey": {
"type": "string"
},
"orderDate": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"shipByDate": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"customerId": {
"type": "integer",
"format": "int32"
},
"customerUsername": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"billTo": {
"$ref": "#/components/schemas/BillTo1"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo3"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item1"
},
"description": ""
},
"amountPaid": {
"type": "number"
},
"taxAmount": {
"type": "integer",
"format": "int32"
},
"shippingAmount": {
"type": "integer",
"format": "int32"
},
"customerNotes": {
"type": "string"
},
"internalNotes": {
"type": "string"
},
"gift": {
"type": "boolean"
},
"giftMessage": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"requestedShippingService": {
"type": "string"
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/components/schemas/InternationalOptions1"
},
"advancedOptions": {
"$ref": "#/components/schemas/AdvancedOptions"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": ""
}
}
},
"BillTo1": {
"title": "BillTo1",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"residential": {
"type": "string",
"nullable": true
}
},
"example": {
"name": "The President",
"company": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"state": null,
"postalCode": null,
"country": null,
"phone": null,
"residential": null
}
},
"ShipTo3": {
"title": "ShipTo3",
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "boolean"
}
},
"example": {
"name": "The President",
"company": "US Govt",
"street1": "1600 Pennsylvania Ave",
"street2": "Oval Office",
"street3": null,
"city": "Washington",
"state": "DC",
"postalCode": "20500",
"country": "US",
"phone": "555-555-5555",
"residential": true
}
},
"Item1": {
"title": "Item1",
"required": [
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"taxAmount",
"shippingAmount",
"warehouseLocation",
"options",
"productId",
"adjustment",
"upc"
],
"type": "object",
"properties": {
"lineItemKey": {
"type": "string",
"example": "vd08-MSLbtx"
},
"sku": {
"type": "string",
"example": "ABC123"
},
"name": {
"type": "string",
"example": "Test item #1"
},
"imageUrl": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 2
},
"unitPrice": {
"type": "number",
"example": 99.99
},
"taxAmount": {
"type": "number",
"example": 2.5
},
"shippingAmount": {
"type": "number",
"example": 5
},
"warehouseLocation": {
"type": "string",
"example": "Aisle 1, Bin 7"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
},
"description": ""
},
"productId": {
"type": "integer",
"format": "int32",
"example": 123456
},
"fulfillmentSku": {
"type": "string",
"nullable": true
},
"adjustment": {
"type": "boolean",
"example": false
},
"upc": {
"type": "string",
"example": "32-65-98"
}
}
},
"InternationalOptions1": {
"title": "InternationalOptions1",
"type": "object",
"properties": {
"contents": {
"type": "string",
"nullable": true
},
"customsItems": {
"type": "string",
"nullable": true
}
},
"example": {
"contents": null,
"customsItems": null
}
},
"Create/UpdateOrderresponse": {
"title": "Create/UpdateOrderresponse",
"required": [
"orderId",
"orderNumber",
"orderKey",
"orderDate",
"createDate",
"modifyDate",
"paymentDate",
"shipByDate",
"orderStatus",
"customerUsername",
"customerEmail",
"billTo",
"shipTo",
"items",
"orderTotal",
"amountPaid",
"taxAmount",
"shippingAmount",
"customerNotes",
"internalNotes",
"gift",
"giftMessage",
"paymentMethod",
"requestedShippingService",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"insuranceOptions",
"internationalOptions",
"advancedOptions",
"externallyFulfilled"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"orderNumber": {
"type": "string"
},
"orderKey": {
"type": "string"
},
"orderDate": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"paymentDate": {
"type": "string"
},
"shipByDate": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"customerId": {
"type": "string",
"nullable": true
},
"customerUsername": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"billTo": {
"$ref": "#/components/schemas/BillTo"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo2"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item2"
},
"description": ""
},
"orderTotal": {
"type": "number"
},
"amountPaid": {
"type": "number"
},
"taxAmount": {
"type": "integer",
"format": "int32"
},
"shippingAmount": {
"type": "integer",
"format": "int32"
},
"customerNotes": {
"type": "string"
},
"internalNotes": {
"type": "string"
},
"gift": {
"type": "boolean"
},
"giftMessage": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"requestedShippingService": {
"type": "string"
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"holdUntilDate": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/components/schemas/InternationalOptions"
},
"advancedOptions": {
"$ref": "#/components/schemas/AdvancedOptions"
},
"tagIds": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"externallyFulfilled": {
"type": "boolean"
},
"externallyFulfilledBy": {
"type": "string",
"nullable": true
}
}
},
"Item2": {
"title": "Item2",
"required": [
"orderItemId",
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"taxAmount",
"shippingAmount",
"warehouseLocation",
"options",
"adjustment",
"upc",
"createDate",
"modifyDate"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"format": "int32",
"example": 192210956
},
"lineItemKey": {
"type": "string",
"example": "vd08-MSLbtx"
},
"sku": {
"type": "string",
"example": "ABC123"
},
"name": {
"type": "string",
"example": "Test item #1"
},
"imageUrl": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 2
},
"unitPrice": {
"type": "number",
"example": 99.99
},
"taxAmount": {
"type": "number",
"example": 2.5
},
"shippingAmount": {
"type": "integer",
"format": "int32",
"example": 5
},
"warehouseLocation": {
"type": "string",
"example": "Aisle 1, Bin 7"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
},
"description": ""
},
"productId": {
"type": "string",
"nullable": true
},
"fulfillmentSku": {
"type": "string",
"nullable": true
},
"adjustment": {
"type": "boolean",
"example": false
},
"upc": {
"type": "string",
"example": "32-65-98"
},
"createDate": {
"type": "string",
"example": "2/16/2016 3:16:53 PM"
},
"modifyDate": {
"type": "string",
"example": "2/16/2016 3:16:53 PM"
}
}
},
"Create/UpdateMultipleOrdersrequest": {
"title": "Create/UpdateMultipleOrdersrequest",
"required": [
"orderNumber",
"orderKey",
"orderDate",
"paymentDate",
"shipByDate",
"orderStatus",
"customerId",
"customerUsername",
"customerEmail",
"billTo",
"shipTo",
"items",
"amountPaid",
"taxAmount",
"shippingAmount",
"customerNotes",
"internalNotes",
"gift",
"giftMessage",
"paymentMethod",
"requestedShippingService",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"insuranceOptions",
"internationalOptions",
"advancedOptions",
"tagIds"
],
"type": "object",
"properties": {
"orderNumber": {
"type": "string",
"example": "TEST-ORDER-API-DOCS"
},
"orderKey": {
"type": "string",
"example": "0f6bec18-3e89-4881-83aa-f392d84f4c74"
},
"orderDate": {
"type": "string",
"example": "6/29/2015 8:46:27 AM"
},
"paymentDate": {
"type": "string",
"example": "6/29/2015 8:46:27 AM"
},
"shipByDate": {
"type": "string",
"example": "7/5/2015 12:00:00 AM"
},
"orderStatus": {
"type": "string",
"example": "awaiting_shipment"
},
"customerId": {
"type": "integer",
"format": "int32",
"example": 37701499
},
"customerUsername": {
"type": "string",
"example": "headhoncho@whitehouse.gov"
},
"customerEmail": {
"type": "string",
"example": "headhoncho@whitehouse.gov"
},
"billTo": {
"$ref": "#/components/schemas/BillTo1"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo3"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item1"
},
"description": ""
},
"amountPaid": {
"type": "number",
"example": 218.73
},
"taxAmount": {
"type": "integer",
"format": "int32",
"example": 5
},
"shippingAmount": {
"type": "integer",
"format": "int32",
"example": 10
},
"customerNotes": {
"type": "string",
"example": "Please ship as soon as possible!"
},
"internalNotes": {
"type": "string",
"example": "Customer called and would like to upgrade shipping"
},
"gift": {
"type": "boolean",
"example": true
},
"giftMessage": {
"type": "string",
"example": "Thank you!"
},
"paymentMethod": {
"type": "string",
"example": "Credit Card"
},
"requestedShippingService": {
"type": "string",
"example": "Priority Mail"
},
"carrierCode": {
"type": "string",
"example": "fedex"
},
"serviceCode": {
"type": "string",
"example": "fedex_2day"
},
"packageCode": {
"type": "string",
"example": "package"
},
"confirmation": {
"type": "string",
"example": "delivery"
},
"shipDate": {
"type": "string",
"example": "2015-07-02"
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/components/schemas/InternationalOptions1"
},
"advancedOptions": {
"$ref": "#/components/schemas/AdvancedOptions"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": ""
}
}
},
"Create/UpdateMultipleOrdersresponse": {
"title": "Create/UpdateMultipleOrdersresponse",
"required": [
"hasErrors",
"results"
],
"type": "object",
"properties": {
"hasErrors": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Result"
},
"description": ""
}
},
"example": {
"hasErrors": false,
"results": [
{
"orderId": 58345234,
"orderNumber": "TEST-ORDER-API-DOCS",
"orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"success": true,
"errorMessage": null
}
]
}
},
"Result": {
"title": "Result",
"required": [
"orderId",
"orderNumber",
"orderKey",
"success"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32",
"example": 58345234
},
"orderNumber": {
"type": "string",
"example": "TEST-ORDER-API-DOCS"
},
"orderKey": {
"type": "string",
"example": "0f6bec18-3e89-4881-83aa-f392d84f4c74"
},
"success": {
"type": "boolean",
"example": true
},
"errorMessage": {
"type": "string",
"nullable": true
}
}
},
"HoldOrderUntilrequest": {
"title": "HoldOrderUntilrequest",
"required": [
"orderId",
"holdUntilDate"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"holdUntilDate": {
"type": "string"
}
},
"example": {
"orderId": 1072467,
"holdUntilDate": "2014-12-01"
}
},
"HoldOrderUntilresponse": {
"title": "HoldOrderUntilresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "Order held successfully."
}
},
"ListOrdersw/oparametersresponse": {
"title": "ListOrdersw/oparametersresponse",
"required": [
"orders",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
}
},
"Order": {
"title": "Order",
"required": [
"orderId",
"orderNumber",
"orderKey",
"orderDate",
"createDate",
"modifyDate",
"paymentDate",
"shipByDate",
"orderStatus",
"customerId",
"customerUsername",
"customerEmail",
"billTo",
"shipTo",
"items",
"orderTotal",
"amountPaid",
"taxAmount",
"shippingAmount",
"customerNotes",
"internalNotes",
"gift",
"requestedShippingService",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"insuranceOptions",
"internationalOptions",
"advancedOptions",
"externallyFulfilled"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32",
"example": 987654321
},
"orderNumber": {
"type": "string",
"example": "Test-International-API-DOCS"
},
"orderKey": {
"type": "string",
"example": "Test-International-API-DOCS"
},
"orderDate": {
"type": "string",
"example": "6/28/2015 5:46:27 PM"
},
"createDate": {
"type": "string",
"example": "8/17/2015 9:24:14 AM"
},
"modifyDate": {
"type": "string",
"example": "8/17/2015 9:24:16 AM"
},
"paymentDate": {
"type": "string",
"example": "6/28/2015 5:46:27 PM"
},
"shipByDate": {
"type": "string",
"example": "7/5/2015 12:00:00 AM"
},
"orderStatus": {
"type": "string",
"example": "awaiting_shipment"
},
"customerId": {
"type": "integer",
"format": "int32",
"example": 63310475
},
"customerUsername": {
"type": "string",
"example": "sholmes1854@methodsofdetection.com"
},
"customerEmail": {
"type": "string",
"example": "sholmes1854@methodsofdetection.com"
},
"billTo": {
"$ref": "#/components/schemas/BillTo"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo6"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item4"
},
"description": ""
},
"orderTotal": {
"type": "number",
"example": 387.97
},
"amountPaid": {
"type": "number",
"example": 412.97
},
"taxAmount": {
"type": "number",
"example": 27.99
},
"shippingAmount": {
"type": "integer",
"format": "int32",
"example": 35
},
"customerNotes": {
"type": "string",
"example": "Please be careful when packing the disguise kits in with the cane."
},
"internalNotes": {
"type": "string",
"example": "Mr. Holmes called to upgrade his shipping to expedited"
},
"gift": {
"type": "boolean",
"example": false
},
"giftMessage": {
"type": "string",
"nullable": true
},
"paymentMethod": {
"type": "string",
"nullable": true
},
"requestedShippingService": {
"type": "string",
"example": "Priority Mail Int"
},
"carrierCode": {
"type": "string",
"example": "stamps_com"
},
"serviceCode": {
"type": "string",
"example": "usps_priority_mail_international"
},
"packageCode": {
"type": "string",
"example": "package"
},
"confirmation": {
"type": "string",
"example": "delivery"
},
"shipDate": {
"type": "string",
"example": "2015-04-25"
},
"holdUntilDate": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions4"
},
"internationalOptions": {
"$ref": "#/components/schemas/InternationalOptions4"
},
"advancedOptions": {
"$ref": "#/components/schemas/AdvancedOptions4"
},
"tagIds": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"externallyFulfilled": {
"type": "boolean",
"example": false
},
"externallyFulfilledBy": {
"type": "string",
"nullable": true
}
}
},
"ShipTo6": {
"title": "ShipTo6",
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"residential",
"addressVerified"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Sherlock Holmes"
},
"company": {
"type": "string"
},
"street1": {
"type": "string",
"example": "221 B Baker St"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"example": "London"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string",
"example": "NW1 6XE"
},
"country": {
"type": "string",
"example": "GB"
},
"phone": {
"type": "string",
"nullable": true
},
"residential": {
"type": "boolean",
"example": true
},
"addressVerified": {
"type": "string",
"example": "Address not yet validated"
}
},
"example": {
"name": "Sherlock Holmes",
"company": "",
"street1": "221 B Baker St",
"street2": "",
"street3": null,
"city": "London",
"state": "",
"postalCode": "NW1 6XE",
"country": "GB",
"phone": null,
"residential": true,
"addressVerified": "Address not yet validated"
}
},
"Item4": {
"title": "Item4",
"required": [
"orderItemId",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"warehouseLocation",
"options",
"productId",
"fulfillmentSku",
"adjustment",
"createDate",
"modifyDate"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"format": "int32",
"example": 136282568
},
"lineItemKey": {
"type": "string",
"nullable": true
},
"sku": {
"type": "string",
"example": "Ele-1234"
},
"name": {
"type": "string",
"example": "Elementary Disguise Kit"
},
"imageUrl": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 2
},
"unitPrice": {
"type": "number",
"example": 49.99
},
"taxAmount": {
"type": "string",
"nullable": true
},
"shippingAmount": {
"type": "string",
"nullable": true
},
"warehouseLocation": {
"type": "string",
"example": "Aisle 1, Bin 7"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
},
"description": ""
},
"productId": {
"type": "integer",
"format": "int32",
"example": 11780610
},
"fulfillmentSku": {
"type": "string",
"example": "Ele-1234"
},
"adjustment": {
"type": "boolean",
"example": false
},
"upc": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string",
"example": "8/17/2015 9:24:14 AM"
},
"modifyDate": {
"type": "string",
"example": "8/17/2015 9:24:14 AM"
}
},
"example": {
"orderItemId": 136282568,
"lineItemKey": "null",
"sku": "Ele-1234",
"name": "Elementary Disguise Kit",
"imageUrl": "null",
"weight": {
"value": 12,
"units": "ounces"
},
"quantity": 2,
"unitPrice": 49.99,
"taxAmount": "null",
"shippingAmount": "null",
"warehouseLocation": "Aisle 1, Bin 7",
"options": [],
"productId": 11780610,
"fulfillmentSku": "Ele-1234",
"adjustment": false,
"upc": "null",
"createDate": "\"2015-08-17T09:24:14.78\"",
"modifyDate": "\"2015-08-17T09:24:14.78\""
}
},
"InsuranceOptions4": {
"title": "InsuranceOptions4",
"required": [
"insureShipment",
"insuredValue"
],
"type": "object",
"properties": {
"provider": {
"type": "string",
"nullable": true
},
"insureShipment": {
"type": "boolean",
"example": false
},
"insuredValue": {
"type": "integer",
"format": "int32",
"example": 0
}
},
"example": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
}
},
"InternationalOptions4": {
"title": "InternationalOptions4",
"required": [
"contents",
"customsItems",
"nonDelivery"
],
"type": "object",
"properties": {
"contents": {
"type": "string",
"example": "merchandise"
},
"customsItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomsItem"
},
"description": ""
},
"nonDelivery": {
"type": "string",
"example": "return_to_sender"
}
}
},
"CustomsItem": {
"title": "CustomsItem",
"required": [
"customsItemId",
"description",
"quantity",
"value",
"countryOfOrigin"
],
"type": "object",
"properties": {
"customsItemId": {
"type": "integer",
"format": "int32",
"example": 11558268
},
"description": {
"type": "string",
"example": "Fine White Oak Cane"
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 1
},
"value": {
"type": "integer",
"format": "int32",
"example": 225
},
"harmonizedTariffCode": {
"type": "string",
"nullable": true
},
"countryOfOrigin": {
"type": "string",
"example": "US"
}
}
},
"AdvancedOptions4": {
"title": "AdvancedOptions4",
"required": [
"warehouseId",
"nonMachinable",
"saturdayDelivery",
"containsAlcohol",
"mergedOrSplit",
"mergedIds",
"storeId",
"customField1",
"customField2"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32",
"example": 98765
},
"nonMachinable": {
"type": "boolean",
"example": false
},
"saturdayDelivery": {
"type": "boolean",
"example": false
},
"containsAlcohol": {
"type": "boolean",
"example": false
},
"mergedOrSplit": {
"type": "boolean",
"example": false
},
"mergedIds": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parentId": {
"type": "string",
"nullable": true
},
"storeId": {
"type": "integer",
"format": "int32",
"example": 12345
},
"customField1": {
"type": "string",
"example": "SKU: CN-9876 x 1"
},
"customField2": {
"type": "string",
"example": "SKU: Ele-123 x 2"
},
"customField3": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"billToParty": {
"type": "string",
"nullable": true
},
"billToAccount": {
"type": "string",
"nullable": true
},
"billToPostalCode": {
"type": "string",
"nullable": true
},
"billToCountryCode": {
"type": "string",
"nullable": true
}
},
"example": {
"warehouseId": 98765,
"nonMachinable": false,
"saturdayDelivery": false,
"containsAlcohol": false,
"mergedOrSplit": false,
"mergedIds": [],
"parentId": null,
"storeId": 12345,
"customField1": "SKU: CN-9876 x 1",
"customField2": "SKU: Ele-123 x 2",
"customField3": null,
"source": null,
"billToParty": null,
"billToAccount": null,
"billToPostalCode": null,
"billToCountryCode": null
}
},
"orderStatus": {
"title": "orderStatus",
"enum": [
"awaiting_payment",
"awaiting_shipment",
"pending_fulfillment",
"shipped",
"on_hold",
"cancelled"
],
"type": "string",
"example": "awaiting_payment"
},
"sortBy2": {
"title": "sortBy2",
"enum": [
"OrderDate",
"ModifyDate",
"CreateDate"
],
"type": "string",
"example": "OrderDate"
},
"ListOrderswithparametersresponse": {
"title": "ListOrderswithparametersresponse",
"required": [
"orders",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
}
},
"ListOrdersbyTagresponse": {
"title": "ListOrdersbyTagresponse",
"required": [
"orders",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order2"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
}
},
"Order2": {
"title": "Order2",
"required": [
"orderId",
"orderNumber",
"orderKey",
"orderDate",
"createDate",
"modifyDate",
"paymentDate",
"shipByDate",
"orderStatus",
"customerId",
"customerUsername",
"customerEmail",
"billTo",
"shipTo",
"items",
"orderTotal",
"amountPaid",
"taxAmount",
"shippingAmount",
"customerNotes",
"internalNotes",
"gift",
"giftMessage",
"paymentMethod",
"requestedShippingService",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"insuranceOptions",
"internationalOptions",
"advancedOptions",
"tagIds",
"userId",
"externallyFulfilled"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32",
"example": 123456789
},
"orderNumber": {
"type": "string",
"example": "TEST-ORDER-API-DOCS"
},
"orderKey": {
"type": "string",
"example": "0f6bec18-3e89-4881-83aa-f392d84f4c74"
},
"orderDate": {
"type": "string",
"example": "6/29/2015 8:46:27 AM"
},
"createDate": {
"type": "string",
"example": "8/17/2015 9:43:03 AM"
},
"modifyDate": {
"type": "string",
"example": "8/17/2015 9:43:12 AM"
},
"paymentDate": {
"type": "string",
"example": "6/29/2015 8:46:27 AM"
},
"shipByDate": {
"type": "string",
"example": "7/5/2015 12:00:00 AM"
},
"orderStatus": {
"type": "string",
"example": "awaiting_shipment"
},
"customerId": {
"type": "integer",
"format": "int32",
"example": 37701499
},
"customerUsername": {
"type": "string",
"example": "headhoncho@whitehouse.gov"
},
"customerEmail": {
"type": "string",
"example": "headhoncho@whitehouse.gov"
},
"billTo": {
"$ref": "#/components/schemas/BillTo"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo2"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item6"
},
"description": ""
},
"orderTotal": {
"type": "number",
"example": 194.43
},
"amountPaid": {
"type": "number",
"example": 218.73
},
"taxAmount": {
"type": "integer",
"format": "int32",
"example": 5
},
"shippingAmount": {
"type": "integer",
"format": "int32",
"example": 10
},
"customerNotes": {
"type": "string",
"example": "Please ship as soon as possible!"
},
"internalNotes": {
"type": "string",
"example": "Customer called and would like to upgrade shipping"
},
"gift": {
"type": "boolean",
"example": true
},
"giftMessage": {
"type": "string",
"example": "Thank you!"
},
"paymentMethod": {
"type": "string",
"example": "Credit Card"
},
"requestedShippingService": {
"type": "string",
"example": "Priority Mail"
},
"carrierCode": {
"type": "string",
"example": "fedex"
},
"serviceCode": {
"type": "string",
"example": "fedex_2day"
},
"packageCode": {
"type": "string",
"example": "package"
},
"confirmation": {
"type": "string",
"example": "delivery"
},
"shipDate": {
"type": "string",
"example": "2015-07-02"
},
"holdUntilDate": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/components/schemas/InternationalOptions"
},
"advancedOptions": {
"$ref": "#/components/schemas/AdvancedOptions"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": ""
},
"userId": {
"type": "string",
"example": "b854f701-e0c2-4156-90fe-19c77cdef27c"
},
"externallyFulfilled": {
"type": "boolean",
"example": false
},
"externallyFulfilledBy": {
"type": "string",
"nullable": true
}
}
},
"Item6": {
"title": "Item6",
"required": [
"orderItemId",
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"taxAmount",
"shippingAmount",
"warehouseLocation",
"options",
"productId",
"adjustment",
"upc",
"createDate",
"modifyDate"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"format": "int32",
"example": 136289188
},
"lineItemKey": {
"type": "string",
"example": "vd08-MSLbtx"
},
"sku": {
"type": "string",
"example": "ABC123"
},
"name": {
"type": "string",
"example": "Test item #1"
},
"imageUrl": {
"type": "string",
"nullable": true
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 2
},
"unitPrice": {
"type": "number",
"example": 99.99
},
"taxAmount": {
"type": "number",
"example": 2.5
},
"shippingAmount": {
"type": "integer",
"format": "int32",
"example": 5
},
"warehouseLocation": {
"type": "string",
"example": "Aisle 1, Bin 7"
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Option"
},
"description": ""
},
"productId": {
"type": "integer",
"format": "int32",
"example": 7239919
},
"fulfillmentSku": {
"type": "string",
"nullable": true
},
"adjustment": {
"type": "boolean",
"example": false
},
"upc": {
"type": "string",
"example": "32-65-98"
},
"createDate": {
"type": "string",
"example": "8/17/2015 9:43:03 AM"
},
"modifyDate": {
"type": "string",
"example": "8/17/2015 9:43:03 AM"
}
}
},
"MarkanOrderasShippedrequest": {
"title": "MarkanOrderasShippedrequest",
"required": [
"orderId",
"carrierCode",
"shipDate",
"trackingNumber",
"notifyCustomer",
"notifySalesChannel"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"carrierCode": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"notifyCustomer": {
"type": "boolean"
},
"notifySalesChannel": {
"type": "boolean"
}
},
"example": {
"orderId": 93348442,
"carrierCode": "usps",
"shipDate": "2014-04-01",
"trackingNumber": "913492493294329421",
"notifyCustomer": true,
"notifySalesChannel": true
}
},
"MarkanOrderasShippedresponse": {
"title": "MarkanOrderasShippedresponse",
"required": [
"orderId",
"orderNumber"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"orderNumber": {
"type": "string"
}
},
"example": {
"orderId": 123456789,
"orderNumber": "ABC123"
}
},
"RemoveTagfromOrderrequest": {
"title": "RemoveTagfromOrderrequest",
"required": [
"orderId",
"tagId"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"tagId": {
"type": "integer",
"format": "int32"
}
},
"example": {
"orderId": 123456,
"tagId": 1234
}
},
"RemoveTagfromOrderresponse": {
"title": "RemoveTagfromOrderresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "Tag removed successfully."
}
},
"RestoreOrderfromOnHoldrequest": {
"title": "RestoreOrderfromOnHoldrequest",
"required": [
"orderId"
],
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
}
},
"example": {
"orderId": 1234567
}
},
"RestoreOrderfromOnHoldresponse": {
"title": "RestoreOrderfromOnHoldresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "The requested order has been restored"
}
},
"UnassignUserfromOrderrequest": {
"title": "UnassignUserfromOrderrequest",
"required": [
"orderIds"
],
"type": "object",
"properties": {
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": ""
}
},
"example": {
"orderIds": [
123456789,
12345679
]
}
},
"UnassignUserfromOrderresponse": {
"title": "UnassignUserfromOrderresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "User unassigned successfully."
}
},
"GetProductresponse": {
"title": "GetProductresponse",
"required": [
"productId",
"sku",
"name",
"price",
"defaultCost",
"length",
"width",
"height",
"weightOz",
"fulfillmentSku",
"createDate",
"modifyDate",
"active",
"productCategory",
"warehouseLocation",
"defaultCarrierCode",
"defaultServiceCode",
"defaultPackageCode",
"defaultIntlCarrierCode",
"defaultIntlServiceCode",
"defaultIntlPackageCode",
"defaultConfirmation",
"defaultIntlConfirmation",
"tags"
],
"type": "object",
"properties": {
"aliases": {
"type": "string",
"nullable": true
},
"productId": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"price": {
"type": "integer",
"format": "int32"
},
"defaultCost": {
"type": "integer",
"format": "int32"
},
"length": {
"type": "integer",
"format": "int32"
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
},
"weightOz": {
"type": "integer",
"format": "int32"
},
"internalNotes": {
"type": "string",
"nullable": true
},
"fulfillmentSku": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"active": {
"type": "boolean"
},
"productCategory": {
"$ref": "#/components/schemas/ProductCategory"
},
"productType": {
"type": "string",
"nullable": true
},
"warehouseLocation": {
"type": "string"
},
"defaultCarrierCode": {
"type": "string"
},
"defaultServiceCode": {
"type": "string"
},
"defaultPackageCode": {
"type": "string"
},
"defaultIntlCarrierCode": {
"type": "string"
},
"defaultIntlServiceCode": {
"type": "string"
},
"defaultIntlPackageCode": {
"type": "string"
},
"defaultConfirmation": {
"type": "string"
},
"defaultIntlConfirmation": {
"type": "string"
},
"customsDescription": {
"type": "string",
"nullable": true
},
"customsValue": {
"type": "string",
"nullable": true
},
"customsTariffNo": {
"type": "string",
"nullable": true
},
"customsCountryCode": {
"type": "string",
"nullable": true
},
"noCustoms": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"description": ""
}
},
"example": {
"aliases": null,
"productId": 12345678,
"sku": "1004",
"name": "Coffee Mug",
"price": 26,
"defaultCost": 0,
"length": 3,
"width": 3,
"height": 3,
"weightOz": 26,
"internalNotes": null,
"fulfillmentSku": "F1004",
"createDate": "2014-09-04T09:18:01.293",
"modifyDate": "2014-09-18T12:38:43.893",
"active": true,
"productCategory": {
"categoryId": 9999,
"name": "Door Closers"
},
"productType": null,
"warehouseLocation": "Bin 22",
"defaultCarrierCode": "fedex",
"defaultServiceCode": "fedex_home_delivery",
"defaultPackageCode": "package",
"defaultIntlCarrierCode": "ups",
"defaultIntlServiceCode": "ups_worldwide_saver",
"defaultIntlPackageCode": "package",
"defaultConfirmation": "direct_signature",
"defaultIntlConfirmation": "adult_signature",
"customsDescription": null,
"customsValue": null,
"customsTariffNo": null,
"customsCountryCode": null,
"noCustoms": null,
"tags": [
{
"tagId": 9180,
"name": "APItest"
}
]
}
},
"ProductCategory": {
"title": "ProductCategory",
"required": [
"categoryId",
"name"
],
"type": "object",
"properties": {
"categoryId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
}
},
"example": {
"categoryId": 9999,
"name": "Door Closers"
}
},
"UpdateProductrequest": {
"title": "UpdateProductrequest",
"required": [
"productId",
"sku",
"name",
"price",
"active"
],
"type": "object",
"properties": {
"aliases": {
"type": "string",
"nullable": true
},
"productId": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"price": {
"type": "integer",
"format": "int32"
},
"defaultCost": {
"type": "string",
"nullable": true
},
"length": {
"type": "string",
"nullable": true
},
"width": {
"type": "string",
"nullable": true
},
"height": {
"type": "string",
"nullable": true
},
"weightOz": {
"type": "string",
"nullable": true
},
"internalNotes": {
"type": "string",
"nullable": true
},
"fulfillmentSku": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
},
"productCategory": {
"type": "string",
"nullable": true
},
"productType": {
"type": "string",
"nullable": true
},
"warehouseLocation": {
"type": "string",
"nullable": true
},
"defaultCarrierCode": {
"type": "string",
"nullable": true
},
"defaultServiceCode": {
"type": "string",
"nullable": true
},
"defaultPackageCode": {
"type": "string",
"nullable": true
},
"defaultIntlCarrierCode": {
"type": "string",
"nullable": true
},
"defaultIntlServiceCode": {
"type": "string",
"nullable": true
},
"defaultIntlPackageCode": {
"type": "string",
"nullable": true
},
"defaultConfirmation": {
"type": "string",
"nullable": true
},
"defaultIntlConfirmation": {
"type": "string",
"nullable": true
},
"customsDescription": {
"type": "string",
"nullable": true
},
"customsValue": {
"type": "string",
"nullable": true
},
"customsTariffNo": {
"type": "string",
"nullable": true
},
"customsCountryCode": {
"type": "string",
"nullable": true
},
"noCustoms": {
"type": "string",
"nullable": true
},
"tags": {
"type": "string",
"nullable": true
}
},
"example": {
"aliases": null,
"productId": 123456789,
"sku": "",
"name": "Beautiful",
"price": 0,
"defaultCost": null,
"length": null,
"width": null,
"height": null,
"weightOz": null,
"internalNotes": null,
"fulfillmentSku": null,
"active": true,
"productCategory": null,
"productType": null,
"warehouseLocation": null,
"defaultCarrierCode": null,
"defaultServiceCode": null,
"defaultPackageCode": null,
"defaultIntlCarrierCode": null,
"defaultIntlServiceCode": null,
"defaultIntlPackageCode": null,
"defaultConfirmation": null,
"defaultIntlConfirmation": null,
"customsDescription": null,
"customsValue": null,
"customsTariffNo": null,
"customsCountryCode": null,
"noCustoms": null,
"tags": null
}
},
"UpdateProductresponse": {
"title": "UpdateProductresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "The requested product has been updated"
}
},
"ListProductsw/oparametersresponse": {
"title": "ListProductsw/oparametersresponse",
"required": [
"products",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
}
},
"Product": {
"title": "Product",
"required": [
"productId",
"sku",
"name",
"price",
"defaultCost",
"length",
"width",
"height",
"weightOz",
"fulfillmentSku",
"createDate",
"modifyDate",
"active",
"productCategory",
"warehouseLocation",
"defaultCarrierCode",
"defaultServiceCode",
"defaultPackageCode",
"defaultIntlCarrierCode",
"defaultIntlServiceCode",
"defaultIntlPackageCode",
"defaultConfirmation",
"defaultIntlConfirmation",
"tags"
],
"type": "object",
"properties": {
"aliases": {
"type": "string",
"nullable": true
},
"productId": {
"type": "integer",
"format": "int32",
"example": 7854008
},
"sku": {
"type": "string",
"example": "1004"
},
"name": {
"type": "string",
"example": "Coffee Mug"
},
"price": {
"type": "integer",
"format": "int32",
"example": 26
},
"defaultCost": {
"type": "integer",
"format": "int32",
"example": 0
},
"length": {
"type": "integer",
"format": "int32",
"example": 3
},
"width": {
"type": "integer",
"format": "int32",
"example": 3
},
"height": {
"type": "integer",
"format": "int32",
"example": 3
},
"weightOz": {
"type": "integer",
"format": "int32",
"example": 26
},
"internalNotes": {
"type": "string",
"nullable": true
},
"fulfillmentSku": {
"type": "string",
"example": "F1004"
},
"createDate": {
"type": "string",
"example": "9/4/2014 9:18:01 AM"
},
"modifyDate": {
"type": "string",
"example": "9/18/2014 12:38:43 PM"
},
"active": {
"type": "boolean",
"example": true
},
"productCategory": {
"$ref": "#/components/schemas/ProductCategory"
},
"productType": {
"type": "string",
"nullable": true
},
"warehouseLocation": {
"type": "string",
"example": "Bin 22"
},
"defaultCarrierCode": {
"type": "string",
"example": "fedex"
},
"defaultServiceCode": {
"type": "string",
"example": "fedex_home_delivery"
},
"defaultPackageCode": {
"type": "string",
"example": "package"
},
"defaultIntlCarrierCode": {
"type": "string",
"example": "ups"
},
"defaultIntlServiceCode": {
"type": "string",
"example": "ups_worldwide_saver"
},
"defaultIntlPackageCode": {
"type": "string",
"example": "package"
},
"defaultConfirmation": {
"type": "string",
"example": "direct_signature"
},
"defaultIntlConfirmation": {
"type": "string",
"example": "adult_signature"
},
"customsDescription": {
"type": "string",
"nullable": true
},
"customsValue": {
"type": "string",
"nullable": true
},
"customsTariffNo": {
"type": "string",
"nullable": true
},
"customsCountryCode": {
"type": "string",
"nullable": true
},
"noCustoms": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"description": ""
}
}
},
"sortBy3": {
"title": "sortBy3",
"enum": [
"SKU",
"ModifyDate",
"CreateDate"
],
"type": "string",
"example": "SKU"
},
"ListProductswithparametersresponse": {
"title": "ListProductswithparametersresponse",
"required": [
"products",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
}
},
"ListShipmentsw/oparametersresponse": {
"title": "ListShipmentsw/oparametersresponse",
"required": [
"shipments",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"example": {
"shipments": [
{
"shipmentId": 33974374,
"orderId": 43945660,
"orderKey": "8061c220f0794a9b92460b8bae6837e4",
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100038-1",
"createDate": "2014-10-03T06:51:33.627",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681189",
"isReturnLabel": false,
"batchNumber": "100301",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 16079,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": "",
"street1": "12223 LOWDEN LN",
"street2": "",
"street3": null,
"city": "MANCHACA",
"state": "TX",
"postalCode": "78652-3602",
"country": "US",
"phone": "2101235544",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 56568665,
"lineItemKey": null,
"sku": "SQ3785739",
"name": "Potato Kitten -",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7565777,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
},
{
"shipmentId": 33974373,
"orderId": 43337328,
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100028",
"createDate": "2014-10-03T06:51:59.943",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681196",
"isReturnLabel": false,
"batchNumber": "100300",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 14265,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Luke Skywalker",
"company": "SS",
"street1": "2815 EXPOSITION BLVD",
"street2": "",
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78703-1221",
"country": "US",
"phone": "",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 55827278,
"lineItemKey": null,
"sku": "test",
"name": "test",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7541107,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
}
],
"total": 2,
"page": 1,
"pages": 0
}
},
"Shipment": {
"title": "Shipment",
"required": [
"shipmentId",
"orderId",
"userId",
"orderNumber",
"createDate",
"shipDate",
"shipmentCost",
"insuranceCost",
"trackingNumber",
"isReturnLabel",
"batchNumber",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"warehouseId",
"voided",
"marketplaceNotified",
"shipTo",
"weight",
"insuranceOptions",
"shipmentItems"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32",
"example": 33974374
},
"orderId": {
"type": "integer",
"format": "int32",
"example": 43945660
},
"orderKey": {
"type": "string",
"example": "8061c220f0794a9b92460b8bae6837e4"
},
"userId": {
"type": "string",
"example": "123456AB-ab12-3c4d-5e67-89f1abc1defa"
},
"orderNumber": {
"type": "string",
"example": "100038-1"
},
"createDate": {
"type": "string",
"example": "10/3/2014 6:51:33 AM"
},
"shipDate": {
"type": "string",
"example": "2014-10-03"
},
"shipmentCost": {
"type": "number",
"example": 1.93
},
"insuranceCost": {
"type": "integer",
"format": "int32",
"example": 0
},
"trackingNumber": {
"type": "string",
"example": "9400111899561704681189"
},
"isReturnLabel": {
"type": "boolean",
"example": false
},
"batchNumber": {
"type": "string",
"example": "100301"
},
"carrierCode": {
"type": "string",
"example": "stamps_com"
},
"serviceCode": {
"type": "string",
"example": "usps_first_class_mail"
},
"packageCode": {
"type": "string",
"example": "package"
},
"confirmation": {
"type": "string",
"example": "delivery"
},
"warehouseId": {
"type": "integer",
"format": "int32",
"example": 16079
},
"voided": {
"type": "boolean",
"example": false
},
"voidDate": {
"type": "string",
"nullable": true
},
"marketplaceNotified": {
"type": "boolean",
"example": true
},
"notifyErrorMessage": {
"type": "string",
"nullable": true
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo9"
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"type": "string",
"nullable": true
},
"insuranceOptions": {
"$ref": "#/components/schemas/InsuranceOptions4"
},
"advancedOptions": {
"type": "string",
"nullable": true
},
"shipmentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentItem"
},
"description": ""
},
"labelData": {
"type": "string",
"nullable": true
},
"formData": {
"type": "string",
"nullable": true
}
}
},
"ShipTo9": {
"title": "ShipTo9",
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"phone"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Yoda"
},
"company": {
"type": "string"
},
"street1": {
"type": "string",
"example": "12223 LOWDEN LN"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"example": "MANCHACA"
},
"state": {
"type": "string",
"example": "TX"
},
"postalCode": {
"type": "string",
"example": "78652-3602"
},
"country": {
"type": "string",
"example": "US"
},
"phone": {
"type": "string",
"example": "2101235544"
},
"residential": {
"type": "string",
"nullable": true
}
},
"example": {
"name": "Yoda",
"company": "",
"street1": "12223 LOWDEN LN",
"street2": "",
"street3": null,
"city": "MANCHACA",
"state": "TX",
"postalCode": "78652-3602",
"country": "US",
"phone": "2101235544",
"residential": null
}
},
"ShipmentItem": {
"title": "ShipmentItem",
"required": [
"orderItemId",
"sku",
"name",
"quantity",
"unitPrice",
"productId"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"format": "int32",
"example": 56568665
},
"lineItemKey": {
"type": "string",
"nullable": true
},
"sku": {
"type": "string",
"example": "SQ3785739"
},
"name": {
"type": "string",
"example": "Potato Kitten -"
},
"imageUrl": {
"type": "string",
"nullable": true
},
"weight": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int32",
"example": 1
},
"unitPrice": {
"type": "integer",
"format": "int32",
"example": 1
},
"warehouseLocation": {
"type": "string",
"nullable": true
},
"options": {
"type": "string",
"nullable": true
},
"productId": {
"type": "integer",
"format": "int32",
"example": 7565777
},
"fulfillmentSku": {
"type": "string",
"nullable": true
}
},
"example": {
"orderItemId": 56568665,
"lineItemKey": null,
"sku": "SQ3785739",
"name": "Potato Kitten -",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7565777,
"fulfillmentSku": null
}
},
"ListShipmentswithparametersresponse": {
"title": "ListShipmentswithparametersresponse",
"required": [
"shipments",
"total",
"page",
"pages"
],
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
},
"description": ""
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"example": {
"shipments": [
{
"shipmentId": 33974374,
"orderId": 43945660,
"orderKey": "8061c220f0794a9b92460b8bae6837e4",
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100038-1",
"createDate": "2014-10-03T06:51:33.627",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681189",
"isReturnLabel": false,
"batchNumber": "100301",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 16079,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Yoda",
"company": "",
"street1": "12223 LOWDEN LN",
"street2": "",
"street3": null,
"city": "MANCHACA",
"state": "TX",
"postalCode": "78652-3602",
"country": "US",
"phone": "2101235544",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 56568665,
"lineItemKey": null,
"sku": "SQ3785739",
"name": "Potato Kitten -",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7565777,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
},
{
"shipmentId": 33974373,
"orderId": 43337328,
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"orderNumber": "100028",
"createDate": "2014-10-03T06:51:59.943",
"shipDate": "2014-10-03",
"shipmentCost": 1.93,
"insuranceCost": 0,
"trackingNumber": "9400111899561704681196",
"isReturnLabel": false,
"batchNumber": "100300",
"carrierCode": "stamps_com",
"serviceCode": "usps_first_class_mail",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": 14265,
"voided": false,
"voidDate": null,
"marketplaceNotified": true,
"notifyErrorMessage": null,
"shipTo": {
"name": "Luke Skywalker",
"company": "SS",
"street1": "2815 EXPOSITION BLVD",
"street2": "",
"street3": null,
"city": "AUSTIN",
"state": "TX",
"postalCode": "78703-1221",
"country": "US",
"phone": "",
"residential": null
},
"weight": {
"value": 1,
"units": "ounces"
},
"dimensions": null,
"insuranceOptions": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"advancedOptions": null,
"shipmentItems": [
{
"orderItemId": 55827278,
"lineItemKey": null,
"sku": "test",
"name": "test",
"imageUrl": null,
"weight": null,
"quantity": 1,
"unitPrice": 1,
"warehouseLocation": null,
"options": null,
"productId": 7541107,
"fulfillmentSku": null
}
],
"labelData": null,
"formData": null
}
],
"total": 2,
"page": 1,
"pages": 0
}
},
"CreateShipmentLabelrequest": {
"title": "CreateShipmentLabelrequest",
"required": [
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"shipFrom",
"shipTo",
"testLabel"
],
"type": "object",
"properties": {
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"shipFrom": {
"$ref": "#/components/schemas/ShipFrom"
},
"shipTo": {
"$ref": "#/components/schemas/ShipTo11"
},
"insuranceOptions": {
"type": "string",
"nullable": true
},
"internationalOptions": {
"type": "string",
"nullable": true
},
"advancedOptions": {
"type": "string",
"nullable": true
},
"testLabel": {
"type": "boolean"
}
},
"example": {
"carrierCode": "fedex",
"serviceCode": "fedex_ground",
"packageCode": "package",
"confirmation": "delivery",
"shipDate": "2014-04-03",
"weight": {
"value": 3,
"units": "ounces"
},
"dimensions": {
"units": "inches",
"length": 7,
"width": 5,
"height": 6
},
"shipFrom": {
"name": "Jason Hodges",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": "Ste 2353242",
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": null,
"residential": false
},
"shipTo": {
"name": "The President",
"company": "US Govt",
"street1": "1600 Pennsylvania Ave",
"street2": "Oval Office",
"street3": null,
"city": "Washington",
"state": "DC",
"postalCode": "20500",
"country": "US",
"phone": null,
"residential": false
},
"insuranceOptions": null,
"internationalOptions": null,
"advancedOptions": null,
"testLabel": false
}
},
"ShipFrom": {
"title": "ShipFrom",
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"residential"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string",
"nullable": true
},
"residential": {
"type": "boolean"
}
}
},
"ShipTo11": {
"title": "ShipTo11",
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"residential"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string",
"nullable": true
},
"residential": {
"type": "boolean"
}
}
},
"CreateShipmentLabelresponse": {
"title": "CreateShipmentLabelresponse",
"required": [
"shipmentId",
"createDate",
"shipDate",
"shipmentCost",
"insuranceCost",
"trackingNumber",
"isReturnLabel",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"voided",
"marketplaceNotified",
"labelData"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32"
},
"orderId": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"customerEmail": {
"type": "string",
"nullable": true
},
"orderNumber": {
"type": "string",
"nullable": true
},
"createDate": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"shipmentCost": {
"type": "number"
},
"insuranceCost": {
"type": "integer",
"format": "int32"
},
"trackingNumber": {
"type": "string"
},
"isReturnLabel": {
"type": "boolean"
},
"batchNumber": {
"type": "string",
"nullable": true
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"warehouseId": {
"type": "string",
"nullable": true
},
"voided": {
"type": "boolean"
},
"voidDate": {
"type": "string",
"nullable": true
},
"marketplaceNotified": {
"type": "boolean"
},
"notifyErrorMessage": {
"type": "string",
"nullable": true
},
"shipTo": {
"type": "string",
"nullable": true
},
"weight": {
"type": "string",
"nullable": true
},
"dimensions": {
"type": "string",
"nullable": true
},
"insuranceOptions": {
"type": "string",
"nullable": true
},
"advancedOptions": {
"type": "string",
"nullable": true
},
"shipmentItems": {
"type": "string",
"nullable": true
},
"labelData": {
"type": "string"
},
"formData": {
"type": "string",
"nullable": true
}
},
"example": {
"shipmentId": 123456789,
"orderId": null,
"userId": null,
"customerEmail": null,
"orderNumber": null,
"createDate": "2016-04-03T12:11:36.863",
"shipDate": "2016-04-03",
"shipmentCost": 9.06,
"insuranceCost": 0,
"trackingNumber": "782390443992",
"isReturnLabel": false,
"batchNumber": null,
"carrierCode": "fedex",
"serviceCode": "fedex_ground",
"packageCode": "package",
"confirmation": "delivery",
"warehouseId": null,
"voided": false,
"voidDate": null,
"marketplaceNotified": false,
"notifyErrorMessage": null,
"shipTo": null,
"weight": null,
"dimensions": null,
"insuranceOptions": null,
"advancedOptions": null,
"shipmentItems": null,
"labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2U...",
"formData": null
}
},
"GetRatesrequest": {
"title": "GetRatesrequest",
"required": [
"carrierCode",
"fromPostalCode",
"toState",
"toCountry",
"toPostalCode",
"toCity",
"weight",
"dimensions",
"confirmation",
"residential"
],
"type": "object",
"properties": {
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string",
"nullable": true
},
"packageCode": {
"type": "string",
"nullable": true
},
"fromPostalCode": {
"type": "string"
},
"toState": {
"type": "string"
},
"toCountry": {
"type": "string"
},
"toPostalCode": {
"type": "string"
},
"toCity": {
"type": "string"
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"confirmation": {
"type": "string"
},
"residential": {
"type": "boolean"
}
},
"example": {
"carrierCode": "fedex",
"serviceCode": null,
"packageCode": null,
"fromPostalCode": "78703",
"toState": "DC",
"toCountry": "US",
"toPostalCode": "20500",
"toCity": "Washington",
"weight": {
"value": 3,
"units": "ounces"
},
"dimensions": {
"units": "inches",
"length": 7,
"width": 5,
"height": 6
},
"confirmation": "delivery",
"residential": false
}
},
"GetRatesresponse": {
"title": "GetRatesresponse",
"required": [
"serviceName",
"serviceCode",
"shipmentCost",
"otherCost"
],
"type": "object",
"properties": {
"serviceName": {
"type": "string",
"example": "FedEx First Overnight®"
},
"serviceCode": {
"type": "string",
"example": "fedex_first_overnight"
},
"shipmentCost": {
"type": "number",
"example": 87.8
},
"otherCost": {
"type": "number",
"example": 2.63
}
},
"example": {
"serviceName": "FedEx First Overnight®",
"serviceCode": "fedex_first_overnight",
"shipmentCost": 87.8,
"otherCost": 2.63
}
},
"VoidLabelrequest": {
"title": "VoidLabelrequest",
"required": [
"shipmentId"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32"
}
},
"example": {
"shipmentId": 12345
}
},
"VoidLabelresponse": {
"title": "VoidLabelresponse",
"required": [
"approved",
"message"
],
"type": "object",
"properties": {
"approved": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"approved": true,
"message": "Label voided successfully"
}
},
"GetStoreresponse": {
"title": "GetStoreresponse",
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"integrationUrl",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh",
"statusMappings"
],
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"storeName": {
"type": "string"
},
"marketplaceId": {
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"type": "string"
},
"accountName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"integrationUrl": {
"type": "string"
},
"active": {
"type": "boolean"
},
"companyName": {
"type": "string"
},
"phone": {
"type": "string"
},
"publicEmail": {
"type": "string"
},
"website": {
"type": "string"
},
"refreshDate": {
"type": "string"
},
"lastRefreshAttempt": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"autoRefresh": {
"type": "boolean"
},
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMapping"
},
"description": ""
}
},
"example": {
"storeId": 12345,
"storeName": "WooCommerce Store",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation-test.wpengine.com",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-12-16T17:47:05.457",
"lastRefreshAttempt": "2014-12-16T09:47:05.457",
"createDate": "2014-11-06T15:21:13.223",
"modifyDate": "2014-11-10T08:02:19.117",
"autoRefresh": true,
"statusMappings": [
{
"orderStatus": "awaiting_payment",
"statusKey": "Pending"
},
{
"orderStatus": "awaiting_shipment",
"statusKey": "Processing"
},
{
"orderStatus": "shipped",
"statusKey": "Completed"
},
{
"orderStatus": "cancelled",
"statusKey": "Cancelled"
},
{
"orderStatus": "on_hold",
"statusKey": "On-hold"
}
]
}
},
"StatusMapping": {
"title": "StatusMapping",
"required": [
"orderStatus",
"statusKey"
],
"type": "object",
"properties": {
"orderStatus": {
"type": "string",
"example": "awaiting_payment"
},
"statusKey": {
"type": "string",
"example": "Pending"
}
}
},
"UpdateStorerequest": {
"title": "UpdateStorerequest",
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"integrationUrl",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh",
"statusMappings"
],
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"storeName": {
"type": "string"
},
"marketplaceId": {
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"type": "string"
},
"accountName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"integrationUrl": {
"type": "string"
},
"active": {
"type": "boolean"
},
"companyName": {
"type": "string"
},
"phone": {
"type": "string"
},
"publicEmail": {
"type": "string"
},
"website": {
"type": "string"
},
"refreshDate": {
"type": "string"
},
"lastRefreshAttempt": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"autoRefresh": {
"type": "boolean"
},
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMapping"
},
"description": ""
}
},
"example": {
"storeId": 12345,
"storeName": "WooCommerce Store",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation-test.wpengine.com",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-12-16T17:47:05.457",
"lastRefreshAttempt": "2014-12-16T09:47:05.457",
"createDate": "2014-11-06T15:21:13.223",
"modifyDate": "2014-11-10T08:02:19.117",
"autoRefresh": true,
"statusMappings": [
{
"orderStatus": "awaiting_payment",
"statusKey": "Pending"
},
{
"orderStatus": "awaiting_shipment",
"statusKey": "Processing"
},
{
"orderStatus": "shipped",
"statusKey": "Completed"
},
{
"orderStatus": "cancelled",
"statusKey": "Cancelled"
},
{
"orderStatus": "on_hold",
"statusKey": "On-hold"
}
]
}
},
"UpdateStoreresponse": {
"title": "UpdateStoreresponse",
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"integrationUrl",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh",
"statusMappings"
],
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"storeName": {
"type": "string"
},
"marketplaceId": {
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"type": "string"
},
"accountName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"integrationUrl": {
"type": "string"
},
"active": {
"type": "boolean"
},
"companyName": {
"type": "string"
},
"phone": {
"type": "string"
},
"publicEmail": {
"type": "string"
},
"website": {
"type": "string"
},
"refreshDate": {
"type": "string"
},
"lastRefreshAttempt": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"autoRefresh": {
"type": "boolean"
},
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMapping"
},
"description": ""
}
},
"example": {
"storeId": 12345,
"storeName": "WooCommerce Store",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation-test.wpengine.com",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-12-16T17:47:05.457",
"lastRefreshAttempt": "2014-12-16T09:47:05.457",
"createDate": "2014-11-06T15:21:13.223",
"modifyDate": "2014-11-10T08:02:19.117",
"autoRefresh": true,
"statusMappings": [
{
"orderStatus": "awaiting_payment",
"statusKey": "Pending"
},
{
"orderStatus": "awaiting_shipment",
"statusKey": "Processing"
},
{
"orderStatus": "shipped",
"statusKey": "Completed"
},
{
"orderStatus": "cancelled",
"statusKey": "Cancelled"
},
{
"orderStatus": "on_hold",
"statusKey": "On-hold"
}
]
}
},
"GetStoreRefreshStatusresponse": {
"title": "GetStoreRefreshStatusresponse",
"required": [
"storeId",
"refreshStatusId",
"refreshStatus",
"lastRefreshAttempt",
"refreshDate"
],
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"refreshStatusId": {
"type": "integer",
"format": "int32"
},
"refreshStatus": {
"type": "string"
},
"lastRefreshAttempt": {
"type": "string"
},
"refreshDate": {
"type": "string"
}
},
"example": {
"storeId": 12345,
"refreshStatusId": 2,
"refreshStatus": "Updating orders",
"lastRefreshAttempt": "8-13-2014",
"refreshDate": "8-13-2014"
}
},
"RefreshStorerequest": {
"title": "RefreshStorerequest",
"required": [
"storeId",
"refreshDate"
],
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"refreshDate": {
"type": "string"
}
},
"example": {
"storeId": 12345,
"refreshDate": "12-08-2014"
}
},
"RefreshStoreresponse": {
"title": "RefreshStoreresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "A store refresh has been initiated for Store ID 12345"
}
},
"ListStoresresponse": {
"title": "ListStoresresponse",
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh"
],
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32",
"example": 22766
},
"storeName": {
"type": "string",
"example": "ShipStation Manual Store"
},
"marketplaceId": {
"type": "integer",
"format": "int32",
"example": 0
},
"marketplaceName": {
"type": "string",
"example": "ShipStation"
},
"accountName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"integrationUrl": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean",
"example": true
},
"companyName": {
"type": "string"
},
"phone": {
"type": "string"
},
"publicEmail": {
"type": "string",
"example": "testemail@email.com"
},
"website": {
"type": "string"
},
"refreshDate": {
"type": "string",
"example": "12/3/2014 11:46:11 AM"
},
"lastRefreshAttempt": {
"type": "string",
"example": "12/3/2014 11:46:53 AM"
},
"createDate": {
"type": "string",
"example": "7/25/2014 11:05:55 AM"
},
"modifyDate": {
"type": "string",
"example": "11/12/2014 8:45:20 AM"
},
"autoRefresh": {
"type": "boolean",
"example": false
}
},
"example": {
"storeId": 22766,
"storeName": "ShipStation Manual Store",
"marketplaceId": 0,
"marketplaceName": "ShipStation",
"accountName": null,
"email": null,
"integrationUrl": null,
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "testemail@email.com",
"website": "",
"refreshDate": "2014-12-03T11:46:11.283",
"lastRefreshAttempt": "2014-12-03T11:46:53.433",
"createDate": "2014-07-25T11:05:55.307",
"modifyDate": "2014-11-12T08:45:20.55",
"autoRefresh": false
}
},
"ListMarketplacesresponse": {
"title": "ListMarketplacesresponse",
"required": [
"name",
"marketplaceId",
"canRefresh",
"supportsCustomMappings",
"supportsCustomStatuses",
"canConfirmShipments"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "3DCart"
},
"marketplaceId": {
"type": "integer",
"format": "int32",
"example": 23
},
"canRefresh": {
"type": "boolean",
"example": true
},
"supportsCustomMappings": {
"type": "boolean",
"example": true
},
"supportsCustomStatuses": {
"type": "boolean",
"example": false
},
"canConfirmShipments": {
"type": "boolean",
"example": true
}
},
"example": {
"name": "3DCart",
"marketplaceId": 23,
"canRefresh": true,
"supportsCustomMappings": true,
"supportsCustomStatuses": false,
"canConfirmShipments": true
}
},
"DeactivateStorerequest": {
"title": "DeactivateStorerequest",
"required": [
"storeId"
],
"type": "object",
"properties": {
"storeId": {
"type": "string"
}
},
"example": {
"storeId": "12345"
}
},
"DeactivateStoreresponse": {
"title": "DeactivateStoreresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "string"
},
"message": {
"type": "string"
}
},
"example": {
"success": "true",
"message": "The requested store has been reactivated."
}
},
"ReactivateStorerequest": {
"title": "ReactivateStorerequest",
"required": [
"storeId"
],
"type": "object",
"properties": {
"storeId": {
"type": "string"
}
},
"example": {
"storeId": "12345"
}
},
"ReactivateStoreresponse": {
"title": "ReactivateStoreresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "string"
},
"message": {
"type": "string"
}
},
"example": {
"success": "true",
"message": "The requested store has been reactivated."
}
},
"ListUsersresponse": {
"title": "ListUsersresponse",
"required": [
"userId",
"userName",
"name"
],
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
}
},
"example": {
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"userName": "SS-user1",
"name": "Shipping Employee 1"
}
},
"GetWarehouseresponse": {
"title": "GetWarehouseresponse",
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/components/schemas/OriginAddress"
},
"returnAddress": {
"$ref": "#/components/schemas/ReturnAddress"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"example": {
"warehouseId": 12345,
"warehouseName": "API Ship From Location",
"originAddress": {
"name": "API Warehouse",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": true,
"addressVerified": null
},
"returnAddress": {
"name": "API Ship From Location",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": null,
"addressVerified": null
},
"createDate": "2015-07-02T08:38:31.487",
"isDefault": true
}
},
"OriginAddress": {
"title": "OriginAddress",
"required": [
"name",
"company",
"street1",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string",
"nullable": true
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "boolean"
},
"addressVerified": {
"type": "string",
"nullable": true
}
}
},
"ReturnAddress": {
"title": "ReturnAddress",
"required": [
"name",
"company",
"street1",
"city",
"state",
"postalCode",
"country",
"phone"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string",
"nullable": true
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "string",
"nullable": true
},
"addressVerified": {
"type": "string",
"nullable": true
}
}
},
"UpdateWarehouserequest": {
"title": "UpdateWarehouserequest",
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/components/schemas/OriginAddress"
},
"returnAddress": {
"$ref": "#/components/schemas/ReturnAddress"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"example": {
"warehouseId": 12345,
"warehouseName": "API Ship From Location",
"originAddress": {
"name": "API Warehouse",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": true,
"addressVerified": null
},
"returnAddress": {
"name": "API Ship From Location",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": null,
"addressVerified": null
},
"createDate": "2015-07-02T08:38:31.487",
"isDefault": true
}
},
"UpdateWarehouseresponse": {
"title": "UpdateWarehouseresponse",
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/components/schemas/OriginAddress"
},
"returnAddress": {
"$ref": "#/components/schemas/ReturnAddress"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"example": {
"warehouseId": 12345,
"warehouseName": "API Ship From Location",
"originAddress": {
"name": "API Warehouse",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": true,
"addressVerified": null
},
"returnAddress": {
"name": "API Ship From Location",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": null,
"addressVerified": null
},
"createDate": "2015-07-02T08:38:31.487",
"isDefault": true
}
},
"DeleteWarehouseresponse": {
"title": "DeleteWarehouseresponse",
"required": [
"success",
"message"
],
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"example": {
"success": true,
"message": "The requested warehouse has been deleted."
}
},
"CreateWarehouserequest": {
"title": "CreateWarehouserequest",
"required": [
"warehouseName",
"originAddress",
"isDefault"
],
"type": "object",
"properties": {
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/components/schemas/OriginAddress3"
},
"returnAddress": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"example": {
"warehouseName": "New Ship From Location",
"originAddress": {
"name": "NM Warehouse",
"company": "White Sands Co.",
"street1": "4704 Arabela Dr.",
"street2": null,
"street3": null,
"city": "Las Cruces",
"state": "NM",
"postalCode": "80012",
"country": "US",
"phone": "512-111-2222",
"residential": true
},
"returnAddress": null,
"isDefault": false
}
},
"OriginAddress3": {
"title": "OriginAddress3",
"required": [
"name",
"company",
"street1",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string",
"nullable": true
},
"street3": {
"type": "string",
"nullable": true
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "boolean"
}
}
},
"CreateWarehouseresponse": {
"title": "CreateWarehouseresponse",
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/components/schemas/OriginAddress4"
},
"returnAddress": {
"$ref": "#/components/schemas/ReturnAddress3"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"example": {
"warehouseId": 17977,
"warehouseName": "New Ship From Location",
"originAddress": {
"name": "NM Warehouse",
"company": "White Sands Co",
"street1": "4704 Arabela Dr.",
"street2": "",
"street3": "",
"city": "Las Cruces",
"state": "NM",
"postalCode": "88012",
"country": "US",
"phone": "512-111-2222",
"residential": true
},
"returnAddress": {
"name": "NM Warehouse",
"company": "White Sands Co",
"street1": "4704 Arabela Dr.",
"street2": "",
"street3": "",
"city": "Las Cruces",
"state": "NM",
"postalCode": "88012",
"country": "US",
"phone": "512-111-2222",
"residential": null
},
"createDate": "2014-10-21T08:11:43.88",
"isDefault": false
}
},
"OriginAddress4": {
"title": "OriginAddress4",
"required": [
"name",
"company",
"street1",
"street2",
"street3",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "boolean"
}
},
"example": {
"name": "Spring warehouse",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": false
}
},
"ReturnAddress3": {
"title": "ReturnAddress3",
"required": [
"name",
"company",
"street1",
"street2",
"street3",
"city",
"state",
"postalCode",
"country",
"phone"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"type": "string",
"nullable": true
}
},
"example": {
"name": "Chicago House",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": null
}
},
"ListWarehousesresponse": {
"title": "ListWarehousesresponse",
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
],
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32",
"example": 17977
},
"warehouseName": {
"type": "string",
"example": "Main warehouse"
},
"originAddress": {
"$ref": "#/components/schemas/OriginAddress4"
},
"returnAddress": {
"$ref": "#/components/schemas/ReturnAddress3"
},
"createDate": {
"type": "string",
"example": "10/21/2014 8:11:43 AM"
},
"isDefault": {
"type": "boolean",
"example": true
}
},
"example": {
"warehouseId": 17977,
"warehouseName": "Main warehouse",
"originAddress": {
"name": "Spring warehouse",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": false
},
"returnAddress": {
"name": "Chicago House",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": null
},
"createDate": "2014-10-21T08:11:43.88",
"isDefault": true
}
},
"ListWebhooksresponse": {
"title": "ListWebhooksresponse",
"required": [
"webhooks"
],
"type": "object",
"properties": {
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
},
"description": ""
}
},
"example": {
"webhooks": [
{
"IsLabelAPIHook": false,
"WebHookID": 123,
"SellerID": 100000,
"StoreID": 12345,
"HookType": "ITEM_ORDER_NOTIFY",
"MessageFormat": "Json",
"Url": "http://example.endpoint/orders",
"Name": "My Order Webhook",
"BulkCopyBatchID": null,
"BulkCopyRecordID": null,
"Active": true,
"WebhookLogs": [],
"Seller": null,
"Store": null
},
{
"IsLabelAPIHook": false,
"WebHookID": 456,
"SellerID": 100000,
"StoreID": 98765,
"HookType": "SHIP_NOTIFY",
"MessageFormat": "Json",
"Url": "https://example.endpoint/shipment",
"Name": "My Shipment Webhook",
"BulkCopyBatchID": null,
"BulkCopyRecordID": null,
"Active": true,
"WebhookLogs": [],
"Seller": null,
"Store": null
}
]
}
},
"Webhook": {
"title": "Webhook",
"required": [
"IsLabelAPIHook",
"WebHookID",
"SellerID",
"StoreID",
"HookType",
"MessageFormat",
"Url",
"Name",
"Active",
"WebhookLogs"
],
"type": "object",
"properties": {
"IsLabelAPIHook": {
"type": "boolean",
"example": false
},
"WebHookID": {
"type": "integer",
"format": "int32",
"example": 123
},
"SellerID": {
"type": "integer",
"format": "int32",
"example": 100000
},
"StoreID": {
"type": "integer",
"format": "int32",
"example": 12345
},
"HookType": {
"type": "string",
"example": "ITEM_ORDER_NOTIFY"
},
"MessageFormat": {
"type": "string",
"example": "Json"
},
"Url": {
"type": "string",
"example": "http://example.endpoint/orders"
},
"Name": {
"type": "string",
"example": "My Order Webhook"
},
"BulkCopyBatchID": {
"type": "string",
"nullable": true
},
"BulkCopyRecordID": {
"type": "string",
"nullable": true
},
"Active": {
"type": "boolean",
"example": true
},
"WebhookLogs": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"Seller": {
"type": "string",
"nullable": true
},
"Store": {
"type": "string",
"nullable": true
}
}
},
"SubscribetoWebhookrequest": {
"title": "SubscribetoWebhookrequest",
"required": [
"target_url",
"event",
"friendly_name"
],
"type": "object",
"properties": {
"target_url": {
"type": "string"
},
"event": {
"type": "string"
},
"store_id": {
"type": "string",
"nullable": true
},
"friendly_name": {
"type": "string"
}
},
"example": {
"target_url": "http://someexamplewebhookurl.com/neworder",
"event": "ORDER_NOTIFY",
"store_id": null,
"friendly_name": "My Webhook"
}
},
"SubscribetoWebhookresponse": {
"title": "SubscribetoWebhookresponse",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
},
"example": {
"id": 123456
}
}
},
"securitySchemes": {
"httpBasic": {
"type": "http",
"scheme": "basic"
}
}
},
"security": [
{
"httpBasic": []
}
],
"tags": [
{
"name": "Accounts",
"description": ""
},
{
"name": "Carriers",
"description": ""
},
{
"name": "Customers",
"description": ""
},
{
"name": "Fulfillments",
"description": ""
},
{
"name": "Orders",
"description": ""
},
{
"name": "Products",
"description": ""
},
{
"name": "Shipments",
"description": ""
},
{
"name": "Stores",
"description": ""
},
{
"name": "Users",
"description": ""
},
{
"name": "Warehouses",
"description": ""
},
{
"name": "Webhooks",
"description": ""
}
]
}
Raw
shipstation-OpenApi3Yaml.yaml
openapi: 3.0.0
info:
title: ShipStation Developer Portal
description: "# Integrating with ShipStation\n\nShipStation strives to streamline shipping for online sellers, no matter where they sell their products online. We are continuously adding new marketplaces, shopping carts, and integration tools, because we know the e-commerce space is growing. \nAs a result, we’ve worked hard to provide developer resources to build custom integrations with ShipStation. If you’re interested in becoming a partner of ours, drop us a line by [filling out this form](http://www.shipstation.com/partners/shipstation-api-custom-store/) and we’ll get in touch.\n\nThere are two methods to integrate with ShipStation:\n\n* Custom Store Integration\n\n* ShipStation API\n\n## Custom Store Integration\n\nLooking for a more 1-to-1 relationship between ShipStation and your chosen selling platform? The Custom Store Integration is the ticket. Our custom store integration is just like any of our other selling channel integration, and could be eligible (based on internal review) as a branded option within the ShipStation admin. It also allows the user to sync orders within ShipStation in a single click, in addition to ShipStation automatically sending shipment status and tracking information \nupdates back to your cart or marketplace once a label is created. It’s the best way to sync up orders with ShipStation and have the most seamless experience.\n\nThe Custom Store allows you to perform two major functions:\n\n* Provide order information to ShipStation, including recipient address, products, customers, etc.\n\n* Receive tracking information when an order is shipped, including shipping method, shipping status, tracking number, and more\n\nTo integrate with the Custom Store, you must expose a web page that renders XML that adheres to the specification defined in the Custom Store Integration Guide. \nWe refer to this page as your “XML Endpoint”. If you can provide us an XML Endpoint, we can *pull* data from your endpoint just like we do with other marketplaces like eBay and Amazon.\n\n**To find out more about our Custom Store Integration, click here: [Custom Store Integration Guide](https://help.shipstation.com/hc/en-us/articles/205928478)**\n\n## ShipStation API\n\nOur API is available for any plan, and allows for read access to almost all data in your account, and write access to create specific objects, like Orders, Customers, and Products. \nThe API is a great way to get data directly to and from ShipStation, like creating products, customers, and querying order & shipping data. Please note that an API integration will not allow you to use your own MarketplaceID that could eventually be branded with your company's logo (see the Custom Store Integration above for that functionality).\n\n**This API allows developers to build applications that interface with the ShipStation platform. The API can be used to automate many tasks including:**\n\n+ Managing Orders\n\n+ Managing Shipments\n\n+ Creating Shipping Labels\n\n+ Retrieving Shipping Rates\n\n+ and more!!!\n\n**To learn more about our API, please review our API documentation below.**\n\n## Which one should I pick?\n\nThe method that's right for your integration very much depends on the type of integration you're planning on implementing. A Custom Store allows ShipStation to *pull* order information from your platform the very same way we *pull* data from marketplaces such as eBay, Amazon, and Shopify. Once an order has been shipped in ShipStation, ShipStation automatically *pushes* tracking information back to your custom store. Though the functionality afforded by this approach is limited to these 2 main functions, much of the *heavy lifting* is performed by ShipStation. Importing orders \nand sending tracking information is performed automatically by ShipStation, as long as your XML endpoint is available to receive our data.\n\nAn API integration, on the other hand, exposes much more functionality, but requires that the developer do much of the heavy lifting. Orders must be *pushed* to ShipStation by using our \"/orders/CreateOrder\" endpoint. The API allows developers to perform functions such as tagging an order, \nshipping an order, creating a shipping label (without an order), retrieving shipping rates, adding funds to a carrier account, creating a warehouse, listing products, and much more. The functionality the API affords are typical actions that a user would perform if using the web app.\n\n### Considerations\n\n* **Will your integration be the main order management tool for the online seller?** If so, the API's broader range of functionality may be the best option.\n\n* **Would you like your store integration to be a branded marketplace within the ShipStation admin?** When you integrate using the Custom Store Integration, you could be eligible to have your company branded within the ShipStation admin. A branded store could have the plugin's logo in the app,\nas well as an easier store setup, order sync, and reporting. Please note, ShipStation makes the final decision, based on integration and partner requirements, on which custom stores are branded within our application.\n\n# ShipStation API Requirements\n\n## End Point\n\nEndpoints are located at the following domain https://ssapi.shipstation.com/ and will need to have a specific reference added to return data. PLEASE NOTE: You cannot access this URL directly and must reference one of the specific endpoints below.\n\n## Authentication\n\nThe ShipStation API uses [Basic HTTP authentication](http://en.wikipedia.org/wiki/Basic_access_authentication). Use your ShipStation ``API Key`` as the username and ``API Secret`` as the password. You can find your ``API Key`` as the username and ``API Secret`` under Settings at https://ss.shipstation.com/#/settings/api .\n\nThe Authorization header is constructed as follows:\n\n+ Username (``API KEY``) and password (``API Secret``) are combined into a string \"username:password\"\n\n+ The resulting string is then encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line\n\n+ The authorization method and a space i.e. \"Basic \" is then put before the encoded string.\n\nFor example, if the ``API KEY`` given is 'ShipStation' and the ``API Secret`` is 'Rocks' then the header is formed as follows:\n\n+ Authorization: Basic U2hpcFN0YXRpb246Um9ja3M=\n\n## API Rate Limits\n\nIn an effort to ensure consistent application performance and increased scalability, we have implemented rate limiting on the ShipStation API. Your integration will need to be able to handle HTTP rate limiting status messages as defined below:\n\n**Response Headers**\n\nAll responses will include headers with status information about rate limiting.\n\n1. X-Rate-Limit-Limit: the maximum number of requests per minute to the endpoint\n\n2. X-Rate-Limit-Remaining: the available requests remaining in the current window\n\n3. X-Rate-Limit-Reset: the number of seconds remaining until the next window begins\n\n**Hitting the Limit**\n\nIf your application hits the rate limit, an HTTP 429 will be returned with this body:\n\n```\n{\n \"message\": \"Too Many Requests\"\n}\n```\n\nAnd these headers, assuming it is 40 seconds into the current window:\n\n```\n{\n \"X-Rate-Limit-Limit\": 60,\n \"X-Rate-Limit-Remaining\": 0,\n \"X-Rate-Limit-Reset\": 20\n}\n```\n\nWhen the limit is reached, your application should stop making requests until X-Rate-Limit-Reset seconds have elapsed. The current Rate limit for each set of the API Key and Secret is 40 requests per minute.\n\nIf you have any issues with the API, please email us at <apisupport@shipstation.com>\n\n## Server Responses\n\nStatus Code | Description\n------------|-------------\n``200`` | OK - The request was successful (some API calls may return 201 instead).\n``201`` | Created - The request was successful and a resource was created.\n``204`` | No Content - The request was successful but there is no representation to return (that is, the response is empty).\n``400`` | Bad Request - The request could not be understood or was missing required parameters.\n``401`` | Unauthorized - Authentication failed or user does not have permissions for the requested operation.\n``403`` | Forbidden - Access denied.\n``404`` | Not Found - Resource was not found.\n``405`` | Method Not Allowed - Requested method is not supported for the specified resource.\n``429`` | Too Many Requests - Exceeded ShipStation API limits. When the limit is reached, your application should stop making requests until X-Rate-Limit-Reset seconds have elapsed.\n``500`` | Internal Server Error - ShipStation has encountered an error.\n\n## DateTime Format and Time Zone\n\nShipStation uses the ISO 8601 combined format for dateTime stamps being submitted to and returned from the API. Please be sure to submit all dateTime values as follows:\n\nyyyy-mm-dd hh:mm:ss (24 hour notation). Example - ``2016-11-29 23:59:59``\n\nThe time zone represented in all API responses is PST/PDT. Similarly, ShipStation asks that you make all time zone convertions and submit any dateTime requests in PST/PDT."
contact: {}
version: '1.0'
servers:
- url: https://ssapi.shipstation.com/
variables: {}
paths:
/accounts/registeraccount:
post:
tags:
- Accounts
summary: Register Account
description: "Creates a new ShipStation account and generates an apiKey and apiSecret to be used by the newly created account. PLEASE NOTE: This endpoint does not require API key and API Secret credentials. The Authorization header can be left off. Use of this specific endpoint requires approval, and is meant only for direct partners of ShipStation. This is the only endpoint to require approval. All other endpoints listed in this document can be accessed by submitting proper authorization credentials in the header of the request. To become a direct partner of ShipStation, or to request more information on becoming a direct partner, we recommend reaching out to our Partners and Integrations team here: https://info.shipstation.com/become-a-partner-api-and-custom-store-integrations\nThe body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``firstName`` | string, required | First Name\n``lastName`` | string, required | Last Name\n``email`` | string, required | Email address. This will also be the username of the account.\n``password`` | string, required | Password to set for account access.\n``companyName`` | string, optional | Name of Company.\n``addr1`` | string, optional | Company Address - Street 1\n``addr2`` | string, optional | Company Address - Street 2\n``city`` | string, optional | Company Address - City\n``state`` | string, optional | Company Address - State \n``zip`` | string, optional | Company Address - Zip Code\n``countryCode`` |string, optional | Company Address - Country. Please use a 2-character country code.\n``phone`` | string, optional | Company Phone number."
operationId: RegisterAccount
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAccountrequest'
example: >-
{
"firstName": "John",
"lastName": "Smith",
"email": "jsmithtest@gmail.com",
"password": "testpw1234",
"shippingOriginCountryCode": "US",
"companyName": "Droid Repair LLC",
"addr1": "542 Midichlorian Rd.",
"addr2": "",
"city": "Austin",
"state": "TX",
"zip": "78703",
"countryCode": "US",
"phone": "5124111234"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAccountresponse'
example:
message: ShipStation account created.
sellerId: 123456
success: true
apiKey: abcdt9845hjmgfklj3498gkljdkuyekl
apiSecret: 1234iou983lkj8mnxgfwu509hkhdy7u3
deprecated: false
security:
- httpBasic: []
/accounts/listtags:
get:
tags:
- Accounts
summary: List Tags
description: Lists all tags defined for this account.
operationId: ListTags
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListTagsresponse'
description: ''
example:
- tagId: 8362
name: Backorder
color: '#800080'
- tagId: 8324
name: Canada
color: '#ff0000'
- tagId: 8336
name: Fragile
color: '#33CCCC'
- tagId: 8221
name: Repeat Buyer
color: '#CC99FF'
deprecated: false
security:
- httpBasic: []
/carriers:
get:
tags:
- Carriers
summary: List Carriers
description: Lists all shipping providers connected to this account.
operationId: ListCarriers
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListCarriersresponse'
description: ''
example:
- name: Stamps.com
code: stamps_com
accountNumber: SS123
requiresFundedAccount: true
balance: 24.27
nickname: null
shippingProviderId: 12345
primary: true
- name: Stamps.com
code: stamps_com
accountNumber: SS1234
requiresFundedAccount: true
balance: 2400.27
nickname: Stamps.com 2
shippingProviderId: 12346
primary: false
- name: UPS
code: ups
accountNumber: ABCR80
requiresFundedAccount: false
balance: 0
nickname: null
shippingProviderId: 12347
primary: true
- name: FedEx
code: fedex
accountNumber: 297929999
requiresFundedAccount: false
balance: 0
nickname: SS
shippingProviderId: 12348
primary: true
- name: Endicia
code: endicia
accountNumber: 913999
requiresFundedAccount: true
balance: 0
nickname: null
shippingProviderId: 12349
primary: true
deprecated: false
security:
- httpBasic: []
/carriers/getcarrier?carrierCode={carrierCode}:
get:
tags:
- Carriers
summary: Get Carrier
description: Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.
operationId: GetCarrier
parameters:
- name: carrierCode
in: path
description: The code for the carrier account to retrieve.
required: true
style: simple
explode: false
schema:
type: string
example: stamps_com
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetCarrierresponse'
example:
name: Stamps.com
code: stamps_com
accountNumber: SS123
requiresFundedAccount: true
balance: 24.27
nickname:
shippingProviderId: 12345
primary: true
deprecated: false
security:
- httpBasic: []
/carriers/addfunds:
post:
tags:
- Carriers
summary: Add Funds
description: >-
Adds funds to a carrier account using the payment information on file. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``carrierCode`` | string, required | The carrier to add funds to.
``amount`` | number, required | The dollar amount to add to the account. The minimum value that can be added is $10.00. The maximum value is $10,000.00.
operationId: AddFunds
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AddFundsrequest'
example: >-
{
"carrierCode": "fedex",
"amount": 20.00
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AddFundsresponse'
example:
name: Stamps.com
code: stamps_com
accountNumber: SS123
requiresFundedAccount: true
balance: 24.140000000000001
deprecated: false
security:
- httpBasic: []
/carriers/listpackages?carrierCode={carrierCode}:
get:
tags:
- Carriers
summary: List Packages
description: Retrieves a list of packages for the specified carrier
operationId: ListPackages
parameters:
- name: carrierCode
in: path
description: The carrier's code
required: true
style: simple
explode: false
schema:
type: string
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListPackagesresponse'
description: ''
example:
- carrierCode: express_1
code: cubic
name: Cubic
domestic: true
international: false
- carrierCode: express_1
code: dvd_flat_rate_box
name: DVD Flat Rate Box
domestic: false
international: true
- carrierCode: express_1
code: flat_rate_envelope
name: Flat Rate Envelope
domestic: true
international: true
- carrierCode: express_1
code: flat_rate_legal_envelope
name: Flat Rate Legal Envelope
domestic: true
international: true
- carrierCode: express_1
code: flat_rate_padded_envelope
name: Flat Rate Padded Envelope
domestic: true
international: true
- carrierCode: express_1
code: large_envelope_or_flat
name: Large Envelope or Flat
domestic: true
international: true
- carrierCode: express_1
code: large_flat_rate_box
name: Large Flat Rate Box
domestic: true
international: true
- carrierCode: express_1
code: large_package
name: Large Package (any side > 12")
domestic: true
international: true
- carrierCode: express_1
code: large_video_flat_rate_box
name: Large Video Flat Rate Box
domestic: false
international: true
- carrierCode: express_1
code: letter
name: Letter
domestic: true
international: true
- carrierCode: express_1
code: medium_flat_rate_box
name: Medium Flat Rate Box
domestic: true
international: true
- carrierCode: express_1
code: package
name: Package
domestic: true
international: true
- carrierCode: express_1
code: regional_rate_box_a
name: Regional Rate Box A
domestic: true
international: false
- carrierCode: express_1
code: regional_rate_box_b
name: Regional Rate Box B
domestic: true
international: false
- carrierCode: express_1
code: regional_rate_box_c
name: Regional Rate Box C
domestic: true
international: false
- carrierCode: express_1
code: small_flat_rate_box
name: Small Flat Rate Box
domestic: true
international: true
- carrierCode: express_1
code: thick_envelope
name: Thick Envelope
domestic: true
international: true
deprecated: false
security:
- httpBasic: []
/carriers/listservices?carrierCode={carrierCode}:
get:
tags:
- Carriers
summary: List Services
description: Retrieves the list of available shipping services provided by the specified carrier
operationId: ListServices
parameters:
- name: carrierCode
in: path
description: The carrier's code
required: true
style: simple
explode: false
schema:
type: string
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListServicesresponse'
description: ''
example:
- carrierCode: fedex
code: fedex_ground
name: FedEx Ground®
domestic: true
international: false
- carrierCode: fedex
code: fedex_home_delivery
name: FedEx Home Delivery®
domestic: true
international: false
- carrierCode: fedex
code: fedex_2day
name: FedEx 2Day®
domestic: true
international: false
- carrierCode: fedex
code: fedex_2day_am
name: FedEx 2Day® A.M.
domestic: true
international: false
- carrierCode: fedex
code: fedex_express_saver
name: FedEx Express Saver®
domestic: true
international: false
- carrierCode: fedex
code: fedex_standard_overnight
name: FedEx Standard Overnight®
domestic: true
international: false
- carrierCode: fedex
code: fedex_priority_overnight
name: FedEx Priority Overnight®
domestic: true
international: false
- carrierCode: fedex
code: fedex_first_overnight
name: FedEx First Overnight®
domestic: true
international: false
- carrierCode: fedex
code: fedex_1_day_freight
name: FedEx 1 Day® Freight
domestic: true
international: false
- carrierCode: fedex
code: fedex_2_day_freight
name: FedEx 2 Day® Freight
domestic: true
international: false
- carrierCode: fedex
code: fedex_3_day_freight
name: FedEx 3 Day® Freight
domestic: true
international: false
- carrierCode: fedex
code: fedex_first_overnight_freight
name: FedEx First Overnight® Freight
domestic: true
international: false
- carrierCode: fedex
code: fedex_ground_international
name: FedEx Ground® International
domestic: false
international: true
- carrierCode: fedex
code: fedex_international_economy
name: FedEx International Economy®
domestic: false
international: true
- carrierCode: fedex
code: fedex_international_priority
name: FedEx International Priority®
domestic: false
international: true
- carrierCode: fedex
code: fedex_international_first
name: FedEx International First®
domestic: false
international: true
- carrierCode: fedex
code: fedex_europe_first
name: FedEx Europe First®
domestic: false
international: true
- carrierCode: fedex
code: fedex_international_economy_freight
name: FedEx International Economy® Freight
domestic: false
international: true
- carrierCode: fedex
code: fedex_international_priority_freight
name: FedEx International Priority® Freight
domestic: false
international: true
deprecated: false
security:
- httpBasic: []
/customers/{customerId}:
get:
tags:
- Customers
summary: Get Customer
description: ''
operationId: GetCustomer
parameters:
- name: customerId
in: path
description: The system generated identifier for the Customer.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345678
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomerresponse'
example:
customerId: 12345678
createDate: '"2014-11-18T10:33:01.19"'
modifyDate: '"2014-11-18T10:33:01.19"'
name: Cam Newton
company: Test Company
street1: 123 War Eagle Lane
street2: ''
city: Auburn
state: AL
postalCode: 36830
countryCode: US
phone: 555-555-5555
email: supermancam@example.com
addressVerified: Verified
marketplaceUsernames:
- customerUserId: 67195020
customerId: 12345678
createDate: '"2015-04-27T12:35:03.83"'
modifyDate: '"2015-05-14T08:16:15.27"'
marketplaceId: 0
marketplace: ShipStation
username: camtheman@gmail.com
- customerUserId: 37568588
customerId: 12345678
createDate: '"2014-11-18T10:33:01.197"'
modifyDate: '"2014-11-18T10:33:01.197"'
marketplaceId: 36
marketplace: WooCommerce
username: supercam@example.com
- customerUserId: 46038940
customerId: 12345678
createDate: null
modifyDate: null
marketplaceId: 67
marketplace: TradeGecko
username: camtheman@gmail.com
tags:
- tagId: 1234
name: Expedited
- tagId: 9725
name: 00 BULK ORDERED
deprecated: false
security:
- httpBasic: []
? /customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}
: get:
tags:
- Customers
summary: List Customers
description: Obtains a list of customers that match the specified criteria.
operationId: ListCustomers
parameters:
- name: stateCode
in: path
description: Returns customers that reside in the specified stateCode.
required: true
style: simple
explode: false
schema:
type: string
- name: countryCode
in: path
description: Returns customers that reside in the specified countryCode.
required: true
style: simple
explode: false
schema:
type: string
- name: marketplaceId
in: path
description: Returns customers that purchased items from the specified marketplaceId.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: tagId
in: path
description: Returns customers that have been tagged with the specified tagId.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: sortBy
in: path
description: Sorts the order of the response based off the specified value.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortBy'
- name: sortDir
in: path
description: Sets the direction of the sort order.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortDir'
- name: page
in: path
description: Page number.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: pageSize
in: path
description: Requested page size. Max value is 500.
required: true
style: simple
explode: false
schema:
type: number
format: double
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomersresponse'
example:
customers:
- customerId: 12345678
createDate: '"2014-11-18T10:33:01.19"'
modifyDate: '"2014-11-18T10:33:01.19"'
name: Cam Newton
company: Test Company
street1: 123 War Eagle Lane
street2: ''
city: Auburn
state: AL
postalCode: 36830
countryCode: US
phone: 555-555-5555
email: supermancam@example.com
addressVerified: Verified
marketplaceUsernames:
- customerUserId: 67195020
customerId: 12345678
createDate: '"2015-04-27T12:35:03.83"'
modifyDate: '"2015-05-14T08:16:15.27"'
marketplaceId: 0
marketplace: ShipStation
username: camtheman@gmail.com
- customerUserId: 37568588
customerId: 12345678
createDate: '"2014-11-18T10:33:01.197"'
modifyDate: '"2014-11-18T10:33:01.197"'
marketplaceId: 36
marketplace: WooCommerce
username: supercam@example.com
- customerUserId: 46038940
customerId: 12345678
createDate: null
modifyDate: null
marketplaceId: 67
marketplace: TradeGecko
username: camtheman@gmail.com
tags:
- tagId: 1234
name: Expedited
- tagId: 9725
name: 00 BULK ORDERED
- customerId: 87654321
createDate: '"2015-06-21T12:48:07.54"'
name: Bo Jackson
company: Test Company
street1: 456 Heisman Ave
street2: ''
city: Auburn
state: AL
postalCode: 36830
countryCode: US
phone: 555-555-5555
email: boknows@example.com
addressVerified: Verified
marketplaceUsernames:
- customerUserId: 77215410
customerId: 87654321
createDate: '"2015-08-27T14:36:05.75"'
modifyDate: '"2015-09-01T09:18:25.31"'
marketplaceId: 0
marketplace: ShipStation
username: boknows@gmail.com
- customerUserId: 43759100
customerId: 87654321
createDate: '"2015-07-05T11:38:01.197"'
modifyDate: '"2015-07-05T11:38:01.197"'
marketplaceId: 36
marketplace: WooCommerce
username: boknows@example.com
- customerUserId: 81565241
customerId: 87654321
createDate: null
modifyDate: null
marketplaceId: 67
marketplace: TradeGecko
username: bo@gmail.com
tags:
- tagId: 1234
name: Expedited
- tagId: 9725
name: 00 BULK ORDERED
total: 2
page: 1
pages: 1
deprecated: false
security:
- httpBasic: []
/fulfillments:
get:
tags:
- Fulfillments
summary: List Fulfillments w/o parameters
description: ''
operationId: ListFulfillmentsW/oParameters
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListFulfillmentsw~1oparametersresponse'
example:
fulfillments:
- fulfillmentId: 33974374
orderId: 191759016
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 783408231234
createDate: 2016-06-07T08:50:50.0670000
shipDate: 2016-06-07T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: USPS
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
- fulfillmentId: 246310
orderId: 193699927
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 664756278745
createDate: 2016-06-08T12:54:53.3470000
shipDate: 2016-06-08T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: FedEx
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
total: 2
page: 1
pages: 0
deprecated: false
security:
- httpBasic: []
? /fulfillments?fulfillmentId={fulfillmentId}&orderId={orderId}&orderNumber={orderNumber}&trackingNumber={trackingNumber}&recipientName={recipientName}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}
: get:
tags:
- Fulfillments
summary: List Fulfillments with parameters
description: >-
Obtains a list of fulfillments that match the specified criteria. Please note the following:
- Orders that have been marked as shipped either through the UI or the API will appear in the response as they are considered fulfillments.
All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:
Url format with filters:
```
fulfillments?fulfillmentId={fulfillmentId}
&orderId={orderId}
&orderNumber={orderNumber}
&trackingNumber={trackingNumber}
&recipientName={recipientName}
&createDateStart={createDateStart}
&createDateEnd={createDateEnd}
&shipDateStart={shipDateStart}
&shipDateEnd={shipDateEnd}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
```
operationId: ListFulfillmentsWithParameters
parameters:
- name: fulfillmentId
in: path
description: Returns the fulfillment with the specified fulfillment ID.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: orderId
in: path
description: Returns fulfillments whose orders have the specified order ID.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: orderNumber
in: path
description: Returns fulfillments whose orders have the specified order number.
required: true
style: simple
explode: false
schema:
type: string
- name: trackingNumber
in: path
description: Returns fulfillments with the specified tracking number.
required: true
style: simple
explode: false
schema:
type: string
- name: recipientName
in: path
description: Returns fulfillments shipped to the specified recipient name.
required: true
style: simple
explode: false
schema:
type: string
- name: createDateStart
in: path
description: Returns fulfillments created on or after the specified ``createDate``
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01 00:00:00
- name: createDateEnd
in: path
description: Returns fulfillments created on or before the specified ``createDate``
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08 00:00:00
- name: shipDateStart
in: path
description: Returns fulfillments with the ``shipDate`` on or after the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01
- name: shipDateEnd
in: path
description: Returns fulfillments with the ``shipDate`` on or before the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08
- name: sortBy
in: path
description: Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending ``createDate``.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortBy1'
- name: sortDir
in: path
description: Sets the direction of the sort order.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortDir'
- name: page
in: path
description: page number.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: pageSize
in: path
description: page size.
required: true
style: simple
explode: false
schema:
type: number
format: double
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListFulfillmentswithparametersresponse'
example:
fulfillments:
- fulfillmentId: 33974374
orderId: 191759016
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 783408231234
createDate: 2016-06-07T08:50:50.0670000
shipDate: 2016-06-07T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: USPS
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
- fulfillmentId: 246310
orderId: 193699927
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 664756278745
createDate: 2016-06-08T12:54:53.3470000
shipDate: 2016-06-08T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: FedEx
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
total: 2
page: 1
pages: 0
deprecated: false
security:
- httpBasic: []
/orders/{orderId}:
get:
tags:
- Orders
summary: Get Order
description: Retrieves a single order from the database.
operationId: GetOrder
parameters:
- name: orderId
in: path
description: The system generated identifier for the order.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 123456789
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetOrderresponse'
deprecated: false
security:
- httpBasic: []
delete:
tags:
- Orders
summary: Delete Order
description: Removes order from ShipStation's UI. Note this is a "soft" delete action so the order will still exist in the database, but will be set to ``inactive``
operationId: DeleteOrder
parameters:
- name: orderId
in: path
description: The system generated identifier for the order.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 123456789
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOrderresponse'
example:
success: true
message: The requested order has been deleted.
deprecated: false
security:
- httpBasic: []
/orders/addtag:
post:
tags:
- Orders
summary: Add Tag to Order
description: >-
Adds a tag to an order. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderId`` | number, required | Identifies the order that will be tagged.
``tagId`` | number, required | Identifies the tag that will be applied to the order.
operationId: AddTagToOrder
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AddTagtoOrderrequest'
example: >-
{
"orderId": 123456,
"tagId": 1234
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AddTagtoOrderresponse'
example:
success: true
message: Tag added successfully.
deprecated: false
security:
- httpBasic: []
/orders/assignuser:
post:
tags:
- Orders
summary: Assign User to Order
description: >-
Assigns a user to an order. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderIds`` | number, required | Identifies set of orders that will be assigned the user. Please note that if ANY of the orders within the array are not found, no orders will have a user assigned to them.
``userId`` | number, required | Identifies the user that will be applied to the orders. It should contain a GUID of the user to be assigned to the array of orders.
operationId: AssignUserToOrder
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AssignUsertoOrderrequest'
example: >-
{
"orderIds": [
123456789,
12345679
],
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AssignUsertoOrderresponse'
example:
success: true
message: User assigned successfully.
deprecated: false
security:
- httpBasic: []
/orders/createlabelfororder:
post:
tags:
- Orders
summary: Create Label for Order
description: >-
Creates a shipping label for a given order. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderId`` | number, required | Identifies the order that will be shipped.
``carrierCode`` | string, required | The code for the carrier that is to be used for the label.
``serviceCode`` | string, required | The code for the shipping service that is to be used for the label.
``confirmation`` | string, required | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.
``shipDate`` | string, required | The date the order should be shipped.
``weight`` | Weight, optional | Weight of the order. Use the [**Weight**](http://www.shipstation.com/developer-api/#/reference/model-weight) model.
``dimensions`` | Dimensions, optional | Dimensions of the order. Use [**Dimensions**](http://www.shipstation.com/developer-api/#/reference/model-dimensions) model.
``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this label. Use the [**InsuranceOptions**](http://www.shipstation.com/developer-api/#/reference/model-insuranceoptions) model.
``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](http://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.
``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the Customs information that can be used to generate customs documents for international orders. Use the [**AdvancedOptions**](http://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model.
``testLabel`` | boolean, required | Specifies whether a test label should be created.
operationId: CreateLabelForOrder
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLabelforOrderrequest'
example: >-
{
"orderId": 93348442,
"carrierCode": "fedex",
"serviceCode": "fedex_2day",
"packageCode": "package",
"confirmation": null,
"shipDate": "2014-04-03",
"weight": {
"value": 2,
"units": "pounds"
},
"dimensions": null,
"insuranceOptions": null,
"internationalOptions": null,
"advancedOptions": null,
"testLabel": false
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLabelforOrderresponse'
example:
shipmentId: 72513480
shipmentCost: 7.2999999999999998
insuranceCost: 0
trackingNumber: 248201115029520
labelData: JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEJDBV0jCz0LBV1jY0M9I4XkXAX9iDRDBZd8hUAuAEdGC7cKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveFswIDAgMjg4IDQzMl0vUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vQ29udGVudHMgMiAwIFIvUGFyZW50....
formData:
deprecated: false
security:
- httpBasic: []
/orders/createorder:
post:
tags:
- Orders
summary: Create/Update Order
description: "If the ``orderKey`` is specified, the method becomes idempotent and the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated through this method. ``cancelled`` and ``shipped`` are locked from modification through the API. The body of this request should specify an [**Order**](https://www.shipstation.com/developer-api/#/reference/model-order) object:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n``orderNumber`` | string, required | A user-defined order number used to identify an order.\n``orderKey`` | string, optional | A user-provided key that should be unique to each order. If an orderKey is not provided, ShipStation will create a new order and generate a unique orderKey for that order. If the orderKey *is* provided, the **createorder** method will either: create a new order if the provided orderKey is not found, or, update the existing order if the orderKey is found.\n``orderDate`` | string, required | The date the order was placed.\n``paymentDate`` | string, optional | The date the order was paid for.\n``shipByDate`` | string, optional | The date the order is to be shipped before or on. This field is a suggested value generated by the order source/platform/cart and passed to ShipStation.\n``orderStatus`` | string, required | The order's status. Possible values: ``awaiting_payment``, ``awaiting_shipment``, ``shipped``, ``on_hold``, ``cancelled``\n``customerUsername`` | string, optional | The customer's username.\n``customerEmail`` | string, optional | The customer's email address.\n``billTo`` | Address, required | The recipients billing address. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n``shipTo`` | Address, required | The recipient's shipping address. Use the [**Address**](http://www.shipstation.com/developer-api/#/reference/model-address) model.\n``items`` | OrderItem, optional | An array of item objects. Use an array of [**OrderItem**](http://www.shipstation.com/developer-api/#/reference/model-orderitem) models.\n``amountPaid`` | number, optional | The total amount paid for the Order.\n``taxAmount`` | number, optional | The total tax amount for the Order.\n``shippingAmount`` | number, optional | Shipping amount paid by the customer, if any.\n``customerNotes`` | string, optional | Notes left by the customer when placing the order.\n``internalNotes`` | string, optional | Private notes that are only visible to the seller.\n``gift`` | boolean, optional | Specifies whether or not this Order is a gift\n``giftMessage`` | string, optional | Gift message left by the customer when placing the order.\n``paymentMethod`` | string, optional | Method of payment used by the customer.\n``requestedShippingService`` | string, optional |Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart and helps identify what shipping service the customer selected upon checkout.\n``carrierCode`` | string, optional | The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).\n``serviceCode`` | string, optional | The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).\n``packageCode`` | string, optional | The code for the package type that is to be used(or was used) when this order is shipped(was shipped).\n``confirmation`` | string, optional | The type of delivery confirmation that is to be used(or was used) when this order is shipped(was shipped). Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only. \n``shipDate`` | string, optional | The date the order was shipped.\n``weight`` | Weight, optional | Weight of the order. Use the [**Weight**](http://www.shipstation.com/developer-api/#/reference/model-weight) model.\n``dimensions`` | Dimensions, optional | Dimensions of the order. Use the [**Dimensions**](http://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this order. Use the [**InsuranceOptions**](http://www.shipstation.com/developer-api/#/reference/model-insuranceoptions) model.\n``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](http://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the [**AdvancedOptions**](http://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model.\n``tagIds``|number[]|Array of tagIds. Each tagId identifies a tag that has been associated with this order."
operationId: Create/updateOrder
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Create~1UpdateOrderrequest'
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Create~1UpdateOrderresponse'
deprecated: false
security:
- httpBasic: []
/orders/createorders:
post:
tags:
- Orders
summary: Create/Update Multiple Orders
description: >-
This endpoint can be used to create or update multiple orders in one request. If the ``orderKey`` is specified in an order, the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated through this method. ``cancelled`` and ``shipped`` are locked from modification through the API.
Data Type |Description
-------------------|-------------------
Order, required | An array of [**Order**](http://www.shipstation.com/developer-api/#/reference/model-order) objects (maximum of 100 per request)
operationId: Create/updateMultipleOrders
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Create~1UpdateMultipleOrdersrequest'
description: ''
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Create~1UpdateMultipleOrdersresponse'
example:
hasErrors: false
results:
- orderId: 58345234
orderNumber: TEST-ORDER-API-DOCS
orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74
success: true
errorMessage:
deprecated: false
security:
- httpBasic: []
/orders/holduntil:
post:
tags:
- Orders
summary: Hold Order Until
description: >-
This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment.
The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderId`` | number, required | Identifies the order that will be held.
``holdUntilDate`` | string, required | Date when order is moved from ``on_hold`` status to ``awaiting_shipment``.
operationId: HoldOrderUntil
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HoldOrderUntilrequest'
example: >-
{
"orderId": 1072467,
"holdUntilDate": "2014-12-01"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/HoldOrderUntilresponse'
example:
success: true
message: Order held successfully.
deprecated: false
security:
- httpBasic: []
/orders:
get:
tags:
- Orders
summary: List Orders w/o parameters
description: ''
operationId: ListOrdersW/oParameters
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrdersw~1oparametersresponse'
deprecated: false
security:
- httpBasic: []
? /orders?customerName={customerName}&itemKeyword={itemKeyword}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&modifyDateStart={modifyDateStart}&modifyDateEnd={modifyDateEnd}&orderDateStart={orderDateStart}&orderDateEnd={orderDateEnd}&orderNumber={orderNumber}&orderStatus={orderStatus}&paymentDateStart={paymentDateStart}&paymentDateEnd={paymentDateEnd}&storeId={storeId}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}
: get:
tags:
- Orders
summary: List Orders with parameters
description: >-
Obtains a list of orders that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:
Url format with filters:
```
/orders?customerName={customerName}
&itemKeyword={itemKeyword}
&createDateStart={createDateStart}
&createDateEnd={createDateEnd}
&modifyDateStart={modifyDateStart}
&modifyDateEnd={modifyDateEnd}
&orderDateStart={orderDateStart}
&orderDateEnd={orderDateEnd}
&orderNumber={orderNumber}
&orderStatus={orderStatus}
&paymentDateStart={paymentDateStart}
&paymentDateEnd={paymentDateEnd}
&storeId={storeId}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
```
operationId: ListOrdersWithParameters
parameters:
- name: customerName
in: path
description: Returns orders that match the specified name.
required: true
style: simple
explode: false
schema:
type: string
example: Smith
- name: itemKeyword
in: path
description: Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options
required: true
style: simple
explode: false
schema:
type: string
example: ABC123
- name: createDateStart
in: path
description: Returns orders that were created in ShipStation after the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01 00:00:00
- name: createDateEnd
in: path
description: Returns orders that were created in ShipStation before the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08 00:00:00
- name: modifyDateStart
in: path
description: Returns orders that were modified after the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01 00:00:00
- name: modifyDateEnd
in: path
description: Returns orders that were modified before the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08 00:00:00
- name: orderDateStart
in: path
description: Returns orders greater than the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01 00:00:00
- name: orderDateEnd
in: path
description: Returns orders less than or equal to the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08 00:00:00
- name: orderNumber
in: path
description: Filter by order number, performs a "starts with" search.
required: true
style: simple
explode: false
schema:
type: string
example: 12345
- name: orderStatus
in: path
description: Filter by order status. If left empty, orders of all statuses are returned.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/orderStatus'
- name: paymentDateStart
in: path
description: Returns orders that were paid after the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01
- name: paymentDateEnd
in: path
description: Returns orders that were paid before the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08
- name: storeId
in: path
description: Filters orders to a single store. Call List Stores to obtain a list of store Ids.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 123456
- name: sortBy
in: path
description: Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending ``orderId``.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortBy2'
- name: sortDir
in: path
description: Sets the direction of the sort order.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortDir'
- name: page
in: path
description: Page number
required: true
style: simple
explode: false
schema:
type: string
- name: pageSize
in: path
description: Requested page size. Max value is 500.
required: true
style: simple
explode: false
schema:
type: string
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrderswithparametersresponse'
deprecated: false
security:
- httpBasic: []
/orders/listbytag?orderStatus={orderStatus}&tagId={tagId}&page={page}&pageSize={pageSize}:
get:
tags:
- Orders
summary: List Orders by Tag
description: >-
Lists all orders that match the specified status and tag ID.
Url format with filters:
```
/listbytag?orderStatus={orderStatus}
&tagId={tagId}
&page={page}
&pageSize={pageSize}
```
operationId: ListOrdersByTag
parameters:
- name: orderStatus
in: path
description: The order's status.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/orderStatus'
- name: tagId
in: path
description: ID of the tag. Call Accounts/ListTags to obtain a list of tags for this account.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: page
in: path
description: Page number
required: true
style: simple
explode: false
schema:
type: string
- name: pageSize
in: path
description: Requested page size. Max value is 500.
required: true
style: simple
explode: false
schema:
type: string
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrdersbyTagresponse'
deprecated: false
security:
- httpBasic: []
/orders/markasshipped:
post:
tags:
- Orders
summary: Mark an Order as Shipped
description: >-
Marks an order as shipped without creating a label in ShipStation. The body of this request has the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderId`` | number, required | Identifies the order that will be marked as shipped.
``carrierCode`` | string, required | Code of the carrier that is marked as having shipped the order.
``shipDate`` | string, optional | Date order was shipped.
``trackingNumber`` | string, optional | Tracking number of shipment.
``notifyCustomer`` | boolean, optional | Specifies whether the customer should be notified of the shipment. Default value: false
``notifySalesChannel`` | boolean, optional | Specifies whether the sales channel should be notified of the shipment. Default value: false
operationId: MarkAnOrderAsShipped
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MarkanOrderasShippedrequest'
example: >-
{
"orderId": 93348442,
"carrierCode": "usps",
"shipDate": "2014-04-01",
"trackingNumber": "913492493294329421",
"notifyCustomer": true,
"notifySalesChannel": true
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MarkanOrderasShippedresponse'
example:
orderId: 123456789
orderNumber: ABC123
deprecated: false
security:
- httpBasic: []
/orders/removetag:
post:
tags:
- Orders
summary: Remove Tag from Order
description: >-
Removes a tag from the specified order. The body of this request has the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderId`` | number, required | Identifies the order whose tag will be removed.
``tagId`` | number, required | Identifies the tag to remove.
operationId: RemoveTagFromOrder
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveTagfromOrderrequest'
example: >-
{
"orderId": 123456,
"tagId": 1234
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveTagfromOrderresponse'
example:
success: true
message: Tag removed successfully.
deprecated: false
security:
- httpBasic: []
/orders/restorefromhold:
post:
tags:
- Orders
summary: Restore Order from On Hold
description: >-
This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a holdUntil Date is attached to an order.
The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderId`` | number, required | Identifies the order that will be restored to ``awaiting_shipment`` from ``on_hold``.
operationId: RestoreOrderFromOnHold
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreOrderfromOnHoldrequest'
example: >-
{
"orderId": 1234567
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreOrderfromOnHoldresponse'
example:
success: true
message: The requested order has been restored
deprecated: false
security:
- httpBasic: []
/orders/unassignuser:
post:
tags:
- Orders
summary: Unassign User from Order
description: >-
Unassigns a user from an order. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``orderIds`` | number, required | Identifies set of orders that will have the user unassigned. Please note that if ANY of the orders within the array are not found, then no orders will have their users unassigned.
operationId: UnassignUserFromOrder
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UnassignUserfromOrderrequest'
example: >-
{
"orderIds": [
123456789,
12345679
]
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UnassignUserfromOrderresponse'
example:
success: true
message: User unassigned successfully.
deprecated: false
security:
- httpBasic: []
/products/{productId}:
get:
tags:
- Products
summary: Get Product
description: ''
operationId: GetProduct
parameters:
- name: productId
in: path
description: The system generated identifier for the Product.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345678
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetProductresponse'
example:
aliases:
productId: 12345678
sku: 1004
name: Coffee Mug
price: 26
defaultCost: 0
length: 3
width: 3
height: 3
weightOz: 26
internalNotes:
fulfillmentSku: F1004
createDate: 2014-09-04T09:18:01.2930000
modifyDate: 2014-09-18T12:38:43.8930000
active: true
productCategory:
categoryId: 9999
name: Door Closers
productType:
warehouseLocation: Bin 22
defaultCarrierCode: fedex
defaultServiceCode: fedex_home_delivery
defaultPackageCode: package
defaultIntlCarrierCode: ups
defaultIntlServiceCode: ups_worldwide_saver
defaultIntlPackageCode: package
defaultConfirmation: direct_signature
defaultIntlConfirmation: adult_signature
customsDescription:
customsValue:
customsTariffNo:
customsCountryCode:
noCustoms:
tags:
- tagId: 9180
name: APItest
deprecated: false
security:
- httpBasic: []
put:
tags:
- Products
summary: Update Product
description: Updates an existing product. This call does not currently support partial updates. The entire resource must be provided in the body of the request.
operationId: UpdateProduct
parameters:
- name: productId
in: path
description: The system generated identifier for the Product.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345678
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProductrequest'
example: >-
{
"aliases": null,
"productId": 123456789,
"sku": "",
"name": "Beautiful",
"price": 0,
"defaultCost": null,
"length": null,
"width": null,
"height": null,
"weightOz": null,
"internalNotes": null,
"fulfillmentSku": null,
"active": true,
"productCategory": null,
"productType": null,
"warehouseLocation": null,
"defaultCarrierCode": null,
"defaultServiceCode": null,
"defaultPackageCode": null,
"defaultIntlCarrierCode": null,
"defaultIntlServiceCode": null,
"defaultIntlPackageCode": null,
"defaultConfirmation": null,
"defaultIntlConfirmation": null,
"customsDescription": null,
"customsValue": null,
"customsTariffNo": null,
"customsCountryCode": null,
"noCustoms": null,
"tags": null
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProductresponse'
example:
success: true
message: The requested product has been updated
deprecated: false
security:
- httpBasic: []
/products:
get:
tags:
- Products
summary: List Products w/o parameters
description: ''
operationId: ListProductsW/oParameters
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListProductsw~1oparametersresponse'
deprecated: false
security:
- httpBasic: []
? /products?sku={sku}&name={name}&productCategoryId={productCategoryId}&productTypeId={productTypeId}&tagId={tagId}&startDate={startDate}&endDate={endDate}&showInactive={showInactive}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}
: get:
tags:
- Products
summary: List Products with parameters
description: >-
Obtains a list of products that match the specified criteria. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:
Url format with filters:
```
/products?sku={sku}
&name={name}
&productCategoryId={productCategoryId}
&productTypeId={productTypeId}
&tagId={tagId}
&startDate={startDate}
&endDate={endDate}
&showInactive={showInactive}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
```
operationId: ListProductsWithParameters
parameters:
- name: sku
in: path
description: Returns products that match the specified SKU.
required: true
style: simple
explode: false
schema:
type: string
- name: name
in: path
description: Returns products that match the specified product name.
required: true
style: simple
explode: false
schema:
type: string
- name: productCategoryId
in: path
description: Returns products that match the specified productCategoryId.
required: true
style: simple
explode: false
schema:
type: string
- name: productTypeId
in: path
description: Returns products that match the specified productTypeId.
required: true
style: simple
explode: false
schema:
type: string
- name: tagId
in: path
description: Returns products that match the specified tagId.
required: true
style: simple
explode: false
schema:
type: string
- name: startDate
in: path
description: Returns products that were created after the specified date.
required: true
style: simple
explode: false
schema:
type: string
- name: endDate
in: path
description: Returns products that were created before the specified date.
required: true
style: simple
explode: false
schema:
type: string
- name: sortBy
in: path
description: Sorts the order of the response based off the specified value.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortBy3'
- name: sortDir
in: path
description: Sets the direction of the sort order.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortDir'
- name: page
in: path
description: Page number.
required: true
style: simple
explode: false
schema:
type: string
- name: pageSize
in: path
description: Requested page size. Max value is 500.
required: true
style: simple
explode: false
schema:
type: string
- name: showInactive
in: path
description: Specifies whether the list should include inactive products.
required: true
style: simple
explode: false
schema:
type: string
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListProductswithparametersresponse'
deprecated: false
security:
- httpBasic: []
/shipments:
get:
tags:
- Shipments
summary: List Shipments w/o parameters
description: ''
operationId: ListShipmentsW/oParameters
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListShipmentsw~1oparametersresponse'
example:
shipments:
- shipmentId: 33974374
orderId: 43945660
orderKey: 8061c220f0794a9b92460b8bae6837e4
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100038-1
createDate: 2014-10-03T06:51:33.6270000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681189
isReturnLabel: false
batchNumber: 100301
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 16079
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company: ''
street1: 12223 LOWDEN LN
street2: ''
street3:
city: MANCHACA
state: TX
postalCode: 78652-3602
country: US
phone: 2101235544
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 56568665
lineItemKey:
sku: SQ3785739
name: Potato Kitten -
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7565777
fulfillmentSku:
labelData:
formData:
- shipmentId: 33974373
orderId: 43337328
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100028
createDate: 2014-10-03T06:51:59.9430000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681196
isReturnLabel: false
batchNumber: 100300
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 14265
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Luke Skywalker
company: SS
street1: 2815 EXPOSITION BLVD
street2: ''
street3:
city: AUSTIN
state: TX
postalCode: 78703-1221
country: US
phone: ''
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 55827278
lineItemKey:
sku: test
name: test
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7541107
fulfillmentSku:
labelData:
formData:
total: 2
page: 1
pages: 0
deprecated: false
security:
- httpBasic: []
? /shipments?recipientName={recipientName}&recipientCountryCode={recipientCountryCode}&orderNumber={orderNumber}&orderId={orderId}&carrierCode={carrierCode}&serviceCode={serviceCode}&trackingNumber={trackingNumber}&createDateStart={createDateStart}&createDateEnd={createDateEnd}&shipDateStart={shipDateStart}&shipDateEnd={shipDateEnd}&voidDateStart={voidDateStart}&voidDateEnd={voidDateEnd}&storeId={storeId}&includeShipmentItems={includeShipmentItems}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}
: get:
tags:
- Shipments
summary: List Shipments with parameters
description: >-
Obtains a list of shipments that match the specified criteria. Please note the following:
- Only valid shipments with labels generated in ShipStation will be returned in the response. Orders that have been marked as shipped either through the UI or the API will not appear as they are considered external shipments.
- To include every shipment's associated shipmentItems in the response, be sure to set the `includeShipmentItems` parameter to `true`.
All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like:
Url format with filters:
```
shipments?recipientName={recipientName}
&recipientCountryCode={recipientCountryCode}
&orderNumber={orderNumber}
&orderId={orderId}
&carrierCode={carrierCode}
&serviceCode={serviceCode}
&trackingNumber={trackingNumber}
&createDateStart={createDateStart}
&createDateEnd={createDateEnd}
&shipDateStart={shipDateStart}
&shipDateEnd={shipDateEnd}
&voidDateStart={voidDateStart}
&voidDateEnd={voidDateEnd}
&storeId={storeId}
&includeShipmentItems={includeShipmentItems}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
```
operationId: ListShipmentsWithParameters
parameters:
- name: recipientName
in: path
description: Returns shipments shipped to the specified recipient name.
required: true
style: simple
explode: false
schema:
type: string
- name: recipientCountryCode
in: path
description: Returns shipments shipped to the specified country code.
required: true
style: simple
explode: false
schema:
type: string
- name: orderNumber
in: path
description: Returns shipments whose orders have the specified order number.
required: true
style: simple
explode: false
schema:
type: string
- name: orderId
in: path
description: Returns shipments whose orders have the specified order ID.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: carrierCode
in: path
description: Returns shipments shipped with the specified carrier.
required: true
style: simple
explode: false
schema:
type: string
- name: serviceCode
in: path
description: Returns shipments shipped with the specified shipping service.
required: true
style: simple
explode: false
schema:
type: string
- name: trackingNumber
in: path
description: Returns shipments with the specified tracking number.
required: true
style: simple
explode: false
schema:
type: string
- name: createDateStart
in: path
description: Returns shipments created on or after the specified ``createDate``
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01 00:00:00
- name: createDateEnd
in: path
description: Returns shipments created on or before the specified ``createDate``
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08 00:00:00
- name: shipDateStart
in: path
description: Returns shipments with the ``shipDate`` on or after the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01
- name: shipDateEnd
in: path
description: Returns shipments with the ``shipDate`` on or before the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08
- name: voidDateStart
in: path
description: Returns shipments voided on or after the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-01 00:00:00
- name: voidDateEnd
in: path
description: Returns shipments voided on or before the specified date
required: true
style: simple
explode: false
schema:
type: string
example: 2015-01-08 00:00:00
- name: storeId
in: path
description: Returns shipments whose orders belong to the specified store ID.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 304352
- name: includeShipmentItems
in: path
description: 'Specifies whether to include shipment items with results Default value: false.'
required: true
style: simple
explode: false
schema:
type: boolean
example: false
- name: sortBy
in: path
description: Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending ``createDate``.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortBy1'
- name: sortDir
in: path
description: Sets the direction of the sort order.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/sortDir'
- name: page
in: path
description: page number.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: pageSize
in: path
description: page size.
required: true
style: simple
explode: false
schema:
type: number
format: double
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListShipmentswithparametersresponse'
example:
shipments:
- shipmentId: 33974374
orderId: 43945660
orderKey: 8061c220f0794a9b92460b8bae6837e4
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100038-1
createDate: 2014-10-03T06:51:33.6270000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681189
isReturnLabel: false
batchNumber: 100301
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 16079
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company: ''
street1: 12223 LOWDEN LN
street2: ''
street3:
city: MANCHACA
state: TX
postalCode: 78652-3602
country: US
phone: 2101235544
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 56568665
lineItemKey:
sku: SQ3785739
name: Potato Kitten -
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7565777
fulfillmentSku:
labelData:
formData:
- shipmentId: 33974373
orderId: 43337328
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100028
createDate: 2014-10-03T06:51:59.9430000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681196
isReturnLabel: false
batchNumber: 100300
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 14265
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Luke Skywalker
company: SS
street1: 2815 EXPOSITION BLVD
street2: ''
street3:
city: AUSTIN
state: TX
postalCode: 78703-1221
country: US
phone: ''
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 55827278
lineItemKey:
sku: test
name: test
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7541107
fulfillmentSku:
labelData:
formData:
total: 2
page: 1
pages: 0
deprecated: false
security:
- httpBasic: []
/shipments/createlabel:
post:
tags:
- Shipments
summary: Create Shipment Label
description: "Creates a shipping label. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request has the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | Identifies the carrier to be used for this label.\n ``serviceCode`` | string, required | Identifies the shipping service to be used for this label.\n ``packageCode`` | string, required | Identifies the packing type that should be used for this label.\n ``confirmation`` | string, optional | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.\n ``shipDate`` | string, required | The date the shipment will be shipped.\n ``weight`` | Weight, required | Shipment's weight. Use the [**Weight**](https://www.shipstation.com/developer-api/#/reference/model-weight) model.\n ``dimensions`` | Dimensions, optional | Shipment's dimensions. Use the [**Dimensions**](https://www.shipstation.com/developer-api/#/reference/model-dimensions) model.\n ``shipFrom`` | Address, required | Address indicating shipment's origin. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``shipTo`` | Address, required | Address indicating shipment's destination. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``returnTo`` | Address, optional | Address indicating return address displayed on the label. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.\n ``insuranceOptions`` | InsuranceOptions, optional | The shipping insurance information associated with this order. \n ``internationalOptions`` | InternationalOptions, optional | Customs information that can be used to generate customs documents for international orders. Use the [**InternationalOptions**](https://www.shipstation.com/developer-api/#/reference/model-internationaloptions) model.\n ``advancedOptions`` | AdvancedOptions, optional | Various advanced options that may be available depending on the shipping carrier that is used to ship the order. Use the [**AdvancedOptions**](https://www.shipstation.com/developer-api/#/reference/model-advancedoptions) model. \n ``testLabel`` | boolean, optional | Specifies whether a test label should be created. Default value: false."
operationId: CreateShipmentLabel
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateShipmentLabelrequest'
example: >-
{
"carrierCode": "fedex",
"serviceCode": "fedex_ground",
"packageCode": "package",
"confirmation": "delivery",
"shipDate": "2014-04-03",
"weight": {
"value": 3,
"units": "ounces"
},
"dimensions": {
"units": "inches",
"length": 7,
"width": 5,
"height": 6
},
"shipFrom": {
"name": "Jason Hodges",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": "Ste 2353242",
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": null,
"residential": false
},
"shipTo": {
"name": "The President",
"company": "US Govt",
"street1": "1600 Pennsylvania Ave",
"street2": "Oval Office",
"street3": null,
"city": "Washington",
"state": "DC",
"postalCode": "20500",
"country": "US",
"phone": null,
"residential": false
},
"insuranceOptions": null,
"internationalOptions": null,
"advancedOptions": null,
"testLabel": false
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CreateShipmentLabelresponse'
example:
shipmentId: 123456789
orderId:
userId:
customerEmail:
orderNumber:
createDate: 2016-04-03T12:11:36.8630000
shipDate: 2016-04-03
shipmentCost: 9.0600000000000005
insuranceCost: 0
trackingNumber: 782390443992
isReturnLabel: false
batchNumber:
carrierCode: fedex
serviceCode: fedex_ground
packageCode: package
confirmation: delivery
warehouseId:
voided: false
voidDate:
marketplaceNotified: false
notifyErrorMessage:
shipTo:
weight:
dimensions:
insuranceOptions:
advancedOptions:
shipmentItems:
labelData: JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2U...
formData:
deprecated: false
security:
- httpBasic: []
/shipments/getrates:
post:
tags:
- Shipments
summary: Get Rates
description: "Retrieves shipping rates for the specified shipping details. The body of this request should specify the following attributes:\nName |Data Type |Description\n-------------------|-------------------|-------------------\n ``carrierCode`` | string, required | Returns rates for the specified carrier.\n ``serviceCode`` | string, optional | Returns rates for the specified shipping service.\n ``packageCode`` | string, optional | Returns rates for the specified package type.\n ``fromPostalCode`` | string, required | Originating postal code.\n ``toState`` | string, optional | Destination State/Province. Please use two-character state/province abbreviation. Note this field is required for the following carriers: UPS\n ``toCountry`` | string, required | Destination Country. Please use the two-character ISO country code.\n ``toPostalCode`` | string, required | Destination Postal Code.\n ``toCity`` | string, optional | Destination City.\n ``weight`` | Weight, required | Shipment's weight. Use ``Weight`` object.\n ``dimensions`` | Dimensions, optional | Shipment's dimensions. Use ``Dimensions`` object. \n ``confirmation`` | string, optional | The type of delivery confirmation that is to be used once the shipment is created. Possible values: ``none``, ``delivery``, ``signature``, ``adult_signature``, and ``direct_signature``. ``direct_signature`` is available for FedEx only.\n ``residential`` | boolean, optional | Returns rates that account for the specified delivery confirmation type. Default value: false"
operationId: GetRates
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetRatesrequest'
example: >-
{
"carrierCode": "fedex",
"serviceCode": null,
"packageCode": null,
"fromPostalCode": "78703",
"toState": "DC",
"toCountry": "US",
"toPostalCode": "20500",
"toCity": "Washington",
"weight": {
"value": 3,
"units": "ounces"
},
"dimensions": {
"units": "inches",
"length": 7,
"width": 5,
"height": 6
},
"confirmation": "delivery",
"residential": false
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GetRatesresponse'
description: ''
example:
- serviceName: FedEx First Overnight®
serviceCode: fedex_first_overnight
shipmentCost: 87.799999999999997
otherCost: 2.6299999999999999
- serviceName: FedEx Priority Overnight®
serviceCode: fedex_priority_overnight
shipmentCost: 50.229999999999997
otherCost: 1.51
- serviceName: FedEx Standard Overnight®
serviceCode: fedex_standard_overnight
shipmentCost: 46.960000000000001
otherCost: 1.4099999999999999
- serviceName: FedEx 2Day® A.M.
serviceCode: fedex_2day_am
shipmentCost: 23.039999999999999
otherCost: 0.68999999999999995
- serviceName: FedEx 2Day®
serviceCode: fedex_2day
shipmentCost: 20.030000000000001
otherCost: 0.59999999999999998
- serviceName: FedEx Express Saver®
serviceCode: fedex_express_saver
shipmentCost: 14.279999999999999
otherCost: 0.42999999999999999
- serviceName: FedEx Ground®
serviceCode: fedex_ground
shipmentCost: 8.25
otherCost: 0.33000000000000002
deprecated: false
security:
- httpBasic: []
/shipments/voidlabel:
post:
tags:
- Shipments
summary: Void Label
description: >-
Voids the specified label by shipmentId. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``shipmentId`` | number, required | ID of the shipment to void.
operationId: VoidLabel
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VoidLabelrequest'
example: >-
{
"shipmentId": 12345
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VoidLabelresponse'
example:
approved: true
message: Label voided successfully
deprecated: false
security:
- httpBasic: []
/stores/{storeId}:
get:
tags:
- Stores
summary: Get Store
description: ''
operationId: GetStore
parameters:
- name: storeId
in: path
description: A unique ID generated by ShipStation and assigned to each store.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345
responses:
200:
description: ''
headers:
Authorization:
content:
text/plain:
schema:
type: string
example: < Enter your Basic Authorization string here >
content:
application/json:
schema:
$ref: '#/components/schemas/GetStoreresponse'
example:
storeId: 12345
storeName: WooCommerce Store
marketplaceId: 36
marketplaceName: WooCommerce
accountName:
email:
integrationUrl: http://shipstation-test.wpengine.com
active: true
companyName: ''
phone: ''
publicEmail: ''
website: ''
refreshDate: 2014-12-16T17:47:05.4570000
lastRefreshAttempt: 2014-12-16T09:47:05.4570000
createDate: 2014-11-06T15:21:13.2230000
modifyDate: 2014-11-10T08:02:19.1170000
autoRefresh: true
statusMappings:
- orderStatus: awaiting_payment
statusKey: Pending
- orderStatus: awaiting_shipment
statusKey: Processing
- orderStatus: shipped
statusKey: Completed
- orderStatus: cancelled
statusKey: Cancelled
- orderStatus: on_hold
statusKey: On-hold
deprecated: false
security:
- httpBasic: []
put:
tags:
- Stores
summary: Update Store
description: Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.
operationId: UpdateStore
parameters:
- name: storeId
in: path
description: A unique ID generated by ShipStation and assigned to each store.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateStorerequest'
example: >-
{
"storeId": 12345,
"storeName": "WooCommerce Store",
"marketplaceId": 36,
"marketplaceName": "WooCommerce",
"accountName": null,
"email": null,
"integrationUrl": "http://shipstation-test.wpengine.com",
"active": true,
"companyName": "",
"phone": "",
"publicEmail": "",
"website": "",
"refreshDate": "2014-12-16T17:47:05.457",
"lastRefreshAttempt": "2014-12-16T09:47:05.457",
"createDate": "2014-11-06T15:21:13.223",
"modifyDate": "2014-11-10T08:02:19.117",
"autoRefresh": true,
"statusMappings": [
{
"orderStatus": "awaiting_payment",
"statusKey": "Pending"
},
{
"orderStatus": "awaiting_shipment",
"statusKey": "Processing"
},
{
"orderStatus": "shipped",
"statusKey": "Completed"
},
{
"orderStatus": "cancelled",
"statusKey": "Cancelled"
},
{
"orderStatus": "on_hold",
"statusKey": "On-hold"
}
]
}
required: true
responses:
200:
description: ''
headers:
Authorization:
content:
text/plain:
schema:
type: string
example: < Enter your Basic Authorization string here >
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateStoreresponse'
example:
storeId: 12345
storeName: WooCommerce Store
marketplaceId: 36
marketplaceName: WooCommerce
accountName:
email:
integrationUrl: http://shipstation-test.wpengine.com
active: true
companyName: ''
phone: ''
publicEmail: ''
website: ''
refreshDate: 2014-12-16T17:47:05.4570000
lastRefreshAttempt: 2014-12-16T09:47:05.4570000
createDate: 2014-11-06T15:21:13.2230000
modifyDate: 2014-11-10T08:02:19.1170000
autoRefresh: true
statusMappings:
- orderStatus: awaiting_payment
statusKey: Pending
- orderStatus: awaiting_shipment
statusKey: Processing
- orderStatus: shipped
statusKey: Completed
- orderStatus: cancelled
statusKey: Cancelled
- orderStatus: on_hold
statusKey: On-hold
deprecated: false
security:
- httpBasic: []
/stores/getrefreshstatus?storeId={storeId}:
get:
tags:
- Stores
summary: Get Store Refresh Status
description: Retrieves the refresh status of a given store.
operationId: GetStoreRefreshStatus
parameters:
- name: storeId
in: path
description: Specifies the store whose status will be retrieved.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/GetStoreRefreshStatusresponse'
example:
storeId: 12345
refreshStatusId: 2
refreshStatus: Updating orders
lastRefreshAttempt: 8-13-2014
refreshDate: 8-13-2014
deprecated: false
security:
- httpBasic: []
/stores/refreshstore?storeId={storeId}&refreshDate={refreshDate}:
post:
tags:
- Stores
summary: Refresh Store
description: Initiates a store refresh.
operationId: RefreshStore
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
- name: storeId
in: path
description: Specifies the store which will get refreshed. If the storeId is not specified, a store refresh will be initiated for all refreshable stores on that account.
required: true
style: simple
explode: false
schema:
type: number
format: double
- name: refreshDate
in: path
description: Specifies the starting date for new order imports. If the refreshDate is not specified, ShipStation will use the last recorded refreshDate for that store.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshStorerequest'
example: >-
{
"storeId": 12345,
"refreshDate": "12-08-2014"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshStoreresponse'
example:
success: true
message: A store refresh has been initiated for Store ID 12345
deprecated: false
security:
- httpBasic: []
/stores?showInactive={showInactive}&marketplaceId={marketplaceId}:
get:
tags:
- Stores
summary: List Stores
description: Retrieve the list of installed stores on the account.
operationId: ListStores
parameters:
- name: showInactive
in: path
description: Determines whether inactive stores will be returned in the list of stores.
required: true
style: simple
explode: false
schema:
type: boolean
example: false
- name: marketplaceId
in: path
description: Returns stores of this marketplace type.
required: true
style: simple
explode: false
schema:
type: number
format: double
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListStoresresponse'
description: ''
example:
- storeId: 22766
storeName: ShipStation Manual Store
marketplaceId: 0
marketplaceName: ShipStation
accountName:
email:
integrationUrl:
active: true
companyName: ''
phone: ''
publicEmail: testemail@email.com
website: ''
refreshDate: 2014-12-03T11:46:11.2830000
lastRefreshAttempt: 2014-12-03T11:46:53.4330000
createDate: 2014-07-25T11:05:55.3070000
modifyDate: 2014-11-12T08:45:20.5500000
autoRefresh: false
- storeId: 25748
storeName: Ashley's Test WooCommerce
marketplaceId: 36
marketplaceName: WooCommerce
accountName:
email:
integrationUrl: http://shipstation.wpengine.com/
active: true
companyName: ''
phone: ''
publicEmail: ''
website: ''
refreshDate: 2014-11-26T22:28:14.0700000
lastRefreshAttempt: 2014-11-26T14:28:14.0700000
createDate: 2014-11-10T08:53:48.0770000
modifyDate: 2014-12-03T14:53:50.5570000
autoRefresh: true
deprecated: false
security:
- httpBasic: []
/stores/marketplaces:
get:
tags:
- Stores
summary: List Marketplaces
description: Lists the marketplaces that can be integrated with ShipStation.
operationId: ListMarketplaces
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListMarketplacesresponse'
description: ''
example:
- name: 3DCart
marketplaceId: 23
canRefresh: true
supportsCustomMappings: true
supportsCustomStatuses: false
canConfirmShipments: true
- name: Amazon
marketplaceId: 2
canRefresh: true
supportsCustomMappings: true
supportsCustomStatuses: false
canConfirmShipments: true
- name: Amazon CA
marketplaceId: 32
canRefresh: true
supportsCustomMappings: true
supportsCustomStatuses: false
canConfirmShipments: true
deprecated: false
security:
- httpBasic: []
/stores/deactivate:
post:
tags:
- Stores
summary: Deactivate Store
description: >-
Deactivates the specified store.
The body of this request has the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``storeId`` | number, required | ID of the store to deactivate.
operationId: DeactivateStore
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeactivateStorerequest'
example: >-
{
"storeId": "12345"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeactivateStoreresponse'
example:
success: true
message: The requested store has been reactivated.
deprecated: false
security:
- httpBasic: []
/stores/reactivate:
post:
tags:
- Stores
summary: Reactivate Store
description: >-
Reactivates the specified store. Note: stores are active by default
The body of this request has the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``storeId`` | number, required | ID of the store to reactivate.
operationId: ReactivateStore
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ReactivateStorerequest'
example: >-
{
"storeId": "12345"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ReactivateStoreresponse'
example:
success: true
message: The requested store has been reactivated.
deprecated: false
security:
- httpBasic: []
/users?showInactive={showInactive}:
get:
tags:
- Users
summary: List Users
description: ''
operationId: ListUsers
parameters:
- name: showInactive
in: path
description: Determines whether inactive users will be returned in the response.
required: true
style: simple
explode: false
schema:
type: boolean
example: false
responses:
200:
description: ''
headers:
Authorization:
content:
text/plain:
schema:
type: string
example: < Enter your Basic Authorization string here >
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersresponse'
example:
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
userName: SS-user1
name: Shipping Employee 1
deprecated: false
security:
- httpBasic: []
/warehouses/{warehouseId}:
get:
tags:
- Warehouses
summary: Get Warehouse
description: Returns a list of active Ship From Locations (formerly known as warehouses) on the ShipStation account. Warehouses are now called "Ship From Locations" in the UI.
operationId: GetWarehouse
parameters:
- name: warehouseId
in: path
description: A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345678
responses:
200:
description: ''
headers:
Authorization:
content:
text/plain:
schema:
type: string
example: < Enter your Basic Authorization string here >
content:
application/json:
schema:
$ref: '#/components/schemas/GetWarehouseresponse'
example:
warehouseId: 12345
warehouseName: API Ship From Location
originAddress:
name: API Warehouse
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential: true
addressVerified:
returnAddress:
name: API Ship From Location
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential:
addressVerified:
createDate: 2015-07-02T08:38:31.4870000
isDefault: true
deprecated: false
security:
- httpBasic: []
put:
tags:
- Warehouses
summary: Update Warehouse
description: Updates an existing Ship From Location (formerly known as warehouse). This call does not currently support partial updates. The entire resource must be provided in the body of the request. If a "returnAddress" object is not specified, your "originAddress" will be used as your "returnAddress".
operationId: UpdateWarehouse
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
- name: warehouseId
in: path
description: A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345678
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWarehouserequest'
example: >-
{
"warehouseId": 12345,
"warehouseName": "API Ship From Location",
"originAddress": {
"name": "API Warehouse",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": true,
"addressVerified": null
},
"returnAddress": {
"name": "API Ship From Location",
"company": "ShipStation",
"street1": "2815 Exposition Blvd",
"street2": null,
"street3": null,
"city": "Austin",
"state": "TX",
"postalCode": "78703",
"country": "US",
"phone": "512-555-5555",
"residential": null,
"addressVerified": null
},
"createDate": "2015-07-02T08:38:31.4870000",
"isDefault": true
}
required: true
responses:
200:
description: ''
headers:
Authorization:
content:
text/plain:
schema:
type: string
example: < Enter your Basic Authorization string here >
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWarehouseresponse'
example:
warehouseId: 12345
warehouseName: API Ship From Location
originAddress:
name: API Warehouse
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential: true
addressVerified:
returnAddress:
name: API Ship From Location
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential:
addressVerified:
createDate: 2015-07-02T08:38:31.4870000
isDefault: true
deprecated: false
security:
- httpBasic: []
delete:
tags:
- Warehouses
summary: Delete Warehouse
description: Removes warehouse from ShipStation's UI. Note this is a "soft" delete action so the warehouse will still exist in the database, but will be set to inactive
operationId: DeleteWarehouse
parameters:
- name: warehouseId
in: path
description: A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345678
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWarehouseresponse'
example:
success: true
message: The requested warehouse has been deleted.
deprecated: false
security:
- httpBasic: []
/warehouses/createwarehouse:
post:
tags:
- Warehouses
summary: Create Warehouse
description: >-
Adds a Ship From Location (formerly known as warehouse) to your account. The body of this request should specify the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``warehouseName`` | string, optional | Name of Ship From Location.
``originAddress`` | Address, required | The origin address. Shipping rates will be calculated from this address. Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.
``returnAddress`` | Address, optional | The return address. If a "returnAddress" is not specified, your "originAddress" will be used as your "returnAddress". Use the [**Address**](https://www.shipstation.com/developer-api/#/reference/model-address) model.
``isDefault`` | boolean, optional | Specifies whether or not this will be your default Ship From Location.
operationId: CreateWarehouse
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWarehouserequest'
example: >-
{
"warehouseName": "New Ship From Location",
"originAddress": {
"name": "NM Warehouse",
"company": "White Sands Co.",
"street1": "4704 Arabela Dr.",
"street2": null,
"street3": null,
"city": "Las Cruces",
"state": "NM",
"postalCode": "80012",
"country": "US",
"phone": "512-111-2222",
"residential": true
},
"returnAddress": null,
"isDefault": false
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWarehouseresponse'
example:
warehouseId: 17977
warehouseName: New Ship From Location
originAddress:
name: NM Warehouse
company: White Sands Co
street1: 4704 Arabela Dr.
street2: ''
street3: ''
city: Las Cruces
state: NM
postalCode: 88012
country: US
phone: 512-111-2222
residential: true
returnAddress:
name: NM Warehouse
company: White Sands Co
street1: 4704 Arabela Dr.
street2: ''
street3: ''
city: Las Cruces
state: NM
postalCode: 88012
country: US
phone: 512-111-2222
residential:
createDate: 2014-10-21T08:11:43.8800000
isDefault: false
deprecated: false
security:
- httpBasic: []
/warehouses:
get:
tags:
- Warehouses
summary: List Warehouses
description: Retrieves a list of your Ship From Locations (formerly known as warehouses).
operationId: ListWarehouses
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListWarehousesresponse'
description: ''
example:
- warehouseId: 17977
warehouseName: Main warehouse
originAddress:
name: Spring warehouse
company: ''
street1: '123 S SPRING RD '
street2: ''
street3: ''
city: Elmurst
state: IL
postalCode: 60126
country: US
phone: 5121112222
residential: false
returnAddress:
name: Chicago House
company: ''
street1: '123 S SPRING RD '
street2: ''
street3: ''
city: Elmurst
state: IL
postalCode: 60126
country: US
phone: 5121112222
residential:
createDate: 2014-10-21T08:11:43.8800000
isDefault: true
- warehouseId: 14265
warehouseName: Austin
originAddress:
name: Austin
company: ShipStation
street1: 2815 Exposition Blvd
street2: ''
street3: ''
city: Austin
state: TX
postalCode: 78703
country: US
phone: 5124445555
residential: false
returnAddress:
name: ShipStation
company: ShipStation
street1: 2815 Exposition Blvd
street2: ''
street3: ''
city: Austin
state: TX
postalCode: 78703
country: US
phone: 5124445555
residential:
createDate: 2014-05-27T09:54:29.9600000
isDefault: false
deprecated: false
security:
- httpBasic: []
/webhooks:
get:
tags:
- Webhooks
summary: List Webhooks
description: Retrieves a list of registered webhooks for the account
operationId: ListWebhooks
parameters: []
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ListWebhooksresponse'
example:
webhooks:
- IsLabelAPIHook: false
WebHookID: 123
SellerID: 100000
StoreID: 12345
HookType: ITEM_ORDER_NOTIFY
MessageFormat: Json
Url: http://example.endpoint/orders
Name: My Order Webhook
BulkCopyBatchID:
BulkCopyRecordID:
Active: true
WebhookLogs: []
Seller:
Store:
- IsLabelAPIHook: false
WebHookID: 456
SellerID: 100000
StoreID: 98765
HookType: SHIP_NOTIFY
MessageFormat: Json
Url: https://example.endpoint/shipment
Name: My Shipment Webhook
BulkCopyBatchID:
BulkCopyRecordID:
Active: true
WebhookLogs: []
Seller:
Store:
deprecated: false
security:
- httpBasic: []
/webhooks/subscribe:
post:
tags:
- Webhooks
summary: Subscribe to Webhook
description: >-
Subscribes to a specific type of webhook. If a ``store_id`` is passed in, the webhooks will only be triggered for that specific ``store_id``.
The ``event`` type that is passed in will determine what type of webhooks will be sent.
Webhooks can be viewed & edited via the ShipStation Application under Integrations in the [**Account Settings**](https://ss.shipstation.com/#/settings/integrations).
NOTE: Webhooks will be sent to the URL specified in the ``target_url``. The HTTP request will be sent via POST and will contain a [**webhook JSON object**](https://www.shipstation.com/developer-api/#/reference/model-webhook) in the body.
The body of this request to subscribe has the following attributes:
Name |Data Type |Description
-------------------|-------------------|-------------------
``target_url`` | string, required | The URL to send the webhooks to
``event`` | string, required | The type of webhook to subscribe to. Must contain one of the following values: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY
``store_id`` | int, optional | If passed in, the webhooks will only be triggered for this ``store_id``
``friendly_name`` | string, optional | Display name for the webhook
operationId: SubscribeToWebhook
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SubscribetoWebhookrequest'
example: >-
{
"target_url": "http://someexamplewebhookurl.com/neworder",
"event": "ORDER_NOTIFY",
"store_id": null,
"friendly_name": "My Webhook"
}
required: true
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SubscribetoWebhookresponse'
example:
id: 123456
deprecated: false
security:
- httpBasic: []
/webhooks/{webhookId}:
delete:
tags:
- Webhooks
summary: Unsubscribe to Webhook
description: Unsubscribes from a certain webhook.
operationId: UnsubscribeToWebhook
parameters:
- name: webhookId
in: path
description: A unique ID generated by ShipStation and assigned to each webhook.
required: true
style: simple
explode: false
schema:
type: number
format: double
example: 12345
- name: Content-Type
in: header
description: ''
required: true
style: simple
explode: false
schema:
type: string
example: application/json
responses:
200:
description: ''
headers: {}
deprecated: false
security:
- httpBasic: []
components:
schemas:
RegisterAccountrequest:
title: RegisterAccountrequest
required:
- firstName
- lastName
- email
- password
- shippingOriginCountryCode
- companyName
- addr1
- addr2
- city
- state
- zip
- countryCode
- phone
type: object
properties:
firstName:
type: string
lastName:
type: string
email:
type: string
password:
type: string
shippingOriginCountryCode:
type: string
companyName:
type: string
addr1:
type: string
addr2:
type: string
city:
type: string
state:
type: string
zip:
type: string
countryCode:
type: string
phone:
type: string
example:
firstName: John
lastName: Smith
email: jsmithtest@gmail.com
password: testpw1234
shippingOriginCountryCode: US
companyName: Droid Repair LLC
addr1: 542 Midichlorian Rd.
addr2: ''
city: Austin
state: TX
zip: 78703
countryCode: US
phone: 5124111234
RegisterAccountresponse:
title: RegisterAccountresponse
required:
- message
- sellerId
- success
- apiKey
- apiSecret
type: object
properties:
message:
type: string
sellerId:
type: integer
format: int32
success:
type: boolean
apiKey:
type: string
apiSecret:
type: string
example:
message: ShipStation account created.
sellerId: 123456
success: true
apiKey: abcdt9845hjmgfklj3498gkljdkuyekl
apiSecret: 1234iou983lkj8mnxgfwu509hkhdy7u3
ListTagsresponse:
title: ListTagsresponse
required:
- tagId
- name
- color
type: object
properties:
tagId:
type: integer
format: int32
example: 8362
name:
type: string
example: Backorder
color:
type: string
example: '#800080'
example:
tagId: 8362
name: Backorder
color: '#800080'
ListCarriersresponse:
title: ListCarriersresponse
required:
- name
- code
- accountNumber
- requiresFundedAccount
- balance
- shippingProviderId
- primary
type: object
properties:
name:
type: string
example: Stamps.com
code:
type: string
example: stamps_com
accountNumber:
type: string
example: SS123
requiresFundedAccount:
type: boolean
example: true
balance:
type: number
example: 24.27
nickname:
type: string
nullable: true
shippingProviderId:
type: integer
format: int32
example: 12345
primary:
type: boolean
example: true
example:
name: Stamps.com
code: stamps_com
accountNumber: SS123
requiresFundedAccount: true
balance: 24.27
nickname: null
shippingProviderId: 12345
primary: true
GetCarrierresponse:
title: GetCarrierresponse
required:
- name
- code
- accountNumber
- requiresFundedAccount
- balance
- shippingProviderId
- primary
type: object
properties:
name:
type: string
code:
type: string
accountNumber:
type: string
requiresFundedAccount:
type: boolean
balance:
type: number
nickname:
type: string
nullable: true
shippingProviderId:
type: integer
format: int32
primary:
type: boolean
example:
name: Stamps.com
code: stamps_com
accountNumber: SS123
requiresFundedAccount: true
balance: 24.27
nickname:
shippingProviderId: 12345
primary: true
AddFundsrequest:
title: AddFundsrequest
required:
- carrierCode
- amount
type: object
properties:
carrierCode:
type: string
amount:
type: number
example:
carrierCode: fedex
amount: 20
AddFundsresponse:
title: AddFundsresponse
required:
- name
- code
- accountNumber
- requiresFundedAccount
- balance
type: object
properties:
name:
type: string
code:
type: string
accountNumber:
type: string
requiresFundedAccount:
type: boolean
balance:
type: number
example:
name: Stamps.com
code: stamps_com
accountNumber: SS123
requiresFundedAccount: true
balance: 24.140000000000001
ListPackagesresponse:
title: ListPackagesresponse
required:
- carrierCode
- code
- name
- domestic
- international
type: object
properties:
carrierCode:
type: string
example: express_1
code:
type: string
example: cubic
name:
type: string
example: Cubic
domestic:
type: boolean
example: true
international:
type: boolean
example: false
example:
carrierCode: express_1
code: cubic
name: Cubic
domestic: true
international: false
ListServicesresponse:
title: ListServicesresponse
required:
- carrierCode
- code
- name
- domestic
- international
type: object
properties:
carrierCode:
type: string
example: fedex
code:
type: string
example: fedex_ground
name:
type: string
example: FedEx Ground®
domestic:
type: boolean
example: true
international:
type: boolean
example: false
example:
carrierCode: fedex
code: fedex_ground
name: FedEx Ground®
domestic: true
international: false
GetCustomerresponse:
title: GetCustomerresponse
required:
- customerId
- createDate
- modifyDate
- name
- company
- street1
- street2
- city
- state
- postalCode
- countryCode
- phone
- email
- addressVerified
- marketplaceUsernames
- tags
type: object
properties:
customerId:
type: integer
format: int32
createDate:
type: string
modifyDate:
type: string
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
city:
type: string
state:
type: string
postalCode:
type: string
countryCode:
type: string
phone:
type: string
email:
type: string
addressVerified:
type: string
marketplaceUsernames:
type: array
items:
$ref: '#/components/schemas/MarketplaceUsername'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
example:
customerId: 12345678
createDate: '"2014-11-18T10:33:01.19"'
modifyDate: '"2014-11-18T10:33:01.19"'
name: Cam Newton
company: Test Company
street1: 123 War Eagle Lane
street2: ''
city: Auburn
state: AL
postalCode: 36830
countryCode: US
phone: 555-555-5555
email: supermancam@example.com
addressVerified: Verified
marketplaceUsernames:
- customerUserId: 67195020
customerId: 12345678
createDate: '"2015-04-27T12:35:03.83"'
modifyDate: '"2015-05-14T08:16:15.27"'
marketplaceId: 0
marketplace: ShipStation
username: camtheman@gmail.com
- customerUserId: 37568588
customerId: 12345678
createDate: '"2014-11-18T10:33:01.197"'
modifyDate: '"2014-11-18T10:33:01.197"'
marketplaceId: 36
marketplace: WooCommerce
username: supercam@example.com
- customerUserId: 46038940
customerId: 12345678
createDate: null
modifyDate: null
marketplaceId: 67
marketplace: TradeGecko
username: camtheman@gmail.com
tags:
- tagId: 1234
name: Expedited
- tagId: 9725
name: 00 BULK ORDERED
MarketplaceUsername:
title: MarketplaceUsername
required:
- customerUserId
- customerId
- createDate
- modifyDate
- marketplaceId
- marketplace
- username
type: object
properties:
customerUserId:
type: integer
format: int32
example: 67195020
customerId:
type: integer
format: int32
example: 12345678
createDate:
type: string
example: 4/27/2015 12:35:03 PM
modifyDate:
type: string
example: 5/14/2015 8:16:15 AM
marketplaceId:
type: integer
format: int32
example: 0
marketplace:
type: string
example: ShipStation
username:
type: string
example: camtheman@gmail.com
example:
customerUserId: 67195020
customerId: 12345678
createDate: '"2015-04-27T12:35:03.83"'
modifyDate: '"2015-05-14T08:16:15.27"'
marketplaceId: 0
marketplace: ShipStation
username: camtheman@gmail.com
Tag:
title: Tag
required:
- tagId
- name
type: object
properties:
tagId:
type: integer
format: int32
example: 1234
name:
type: string
example: Expedited
example:
tagId: 1234
name: Expedited
sortBy:
title: sortBy
enum:
- Name
- ModifyDate
- CreateDate
type: string
example: Name
sortDir:
title: sortDir
enum:
- ASC
- DESC
type: string
example: ASC
ListCustomersresponse:
title: ListCustomersresponse
required:
- customers
- total
- page
- pages
type: object
properties:
customers:
type: array
items:
$ref: '#/components/schemas/Customer'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
example:
customers:
- customerId: 12345678
createDate: '"2014-11-18T10:33:01.19"'
modifyDate: '"2014-11-18T10:33:01.19"'
name: Cam Newton
company: Test Company
street1: 123 War Eagle Lane
street2: ''
city: Auburn
state: AL
postalCode: 36830
countryCode: US
phone: 555-555-5555
email: supermancam@example.com
addressVerified: Verified
marketplaceUsernames:
- customerUserId: 67195020
customerId: 12345678
createDate: '"2015-04-27T12:35:03.83"'
modifyDate: '"2015-05-14T08:16:15.27"'
marketplaceId: 0
marketplace: ShipStation
username: camtheman@gmail.com
- customerUserId: 37568588
customerId: 12345678
createDate: '"2014-11-18T10:33:01.197"'
modifyDate: '"2014-11-18T10:33:01.197"'
marketplaceId: 36
marketplace: WooCommerce
username: supercam@example.com
- customerUserId: 46038940
customerId: 12345678
createDate: null
modifyDate: null
marketplaceId: 67
marketplace: TradeGecko
username: camtheman@gmail.com
tags:
- tagId: 1234
name: Expedited
- tagId: 9725
name: 00 BULK ORDERED
- customerId: 87654321
createDate: '"2015-06-21T12:48:07.54"'
name: Bo Jackson
company: Test Company
street1: 456 Heisman Ave
street2: ''
city: Auburn
state: AL
postalCode: 36830
countryCode: US
phone: 555-555-5555
email: boknows@example.com
addressVerified: Verified
marketplaceUsernames:
- customerUserId: 77215410
customerId: 87654321
createDate: '"2015-08-27T14:36:05.75"'
modifyDate: '"2015-09-01T09:18:25.31"'
marketplaceId: 0
marketplace: ShipStation
username: boknows@gmail.com
- customerUserId: 43759100
customerId: 87654321
createDate: '"2015-07-05T11:38:01.197"'
modifyDate: '"2015-07-05T11:38:01.197"'
marketplaceId: 36
marketplace: WooCommerce
username: boknows@example.com
- customerUserId: 81565241
customerId: 87654321
createDate: null
modifyDate: null
marketplaceId: 67
marketplace: TradeGecko
username: bo@gmail.com
tags:
- tagId: 1234
name: Expedited
- tagId: 9725
name: 00 BULK ORDERED
total: 2
page: 1
pages: 1
Customer:
title: Customer
required:
- customerId
- createDate
- name
- company
- street1
- street2
- city
- state
- postalCode
- countryCode
- phone
- email
- addressVerified
- marketplaceUsernames
- tags
type: object
properties:
customerId:
type: integer
format: int32
example: 12345678
createDate:
type: string
example: 11/18/2014 10:33:01 AM
modifyDate:
type: string
example: 11/18/2014 10:33:01 AM
name:
type: string
example: Cam Newton
company:
type: string
example: Test Company
street1:
type: string
example: 123 War Eagle Lane
street2:
type: string
city:
type: string
example: Auburn
state:
type: string
example: AL
postalCode:
type: string
example: 36830
countryCode:
type: string
example: US
phone:
type: string
example: 555-555-5555
email:
type: string
example: supermancam@example.com
addressVerified:
type: string
example: Verified
marketplaceUsernames:
type: array
items:
$ref: '#/components/schemas/MarketplaceUsername'
description: ''
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
ListFulfillmentsw/oparametersresponse:
title: ListFulfillmentsw/oparametersresponse
required:
- fulfillments
- total
- page
- pages
type: object
properties:
fulfillments:
type: array
items:
$ref: '#/components/schemas/Fulfillment'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
example:
fulfillments:
- fulfillmentId: 33974374
orderId: 191759016
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 783408231234
createDate: 2016-06-07T08:50:50.0670000
shipDate: 2016-06-07T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: USPS
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
- fulfillmentId: 246310
orderId: 193699927
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 664756278745
createDate: 2016-06-08T12:54:53.3470000
shipDate: 2016-06-08T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: FedEx
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
total: 2
page: 1
pages: 0
Fulfillment:
title: Fulfillment
required:
- fulfillmentId
- orderId
- orderNumber
- userId
- customerEmail
- trackingNumber
- createDate
- shipDate
- carrierCode
- fulfillmentFee
- voidRequested
- voided
- marketplaceNotified
- shipTo
type: object
properties:
fulfillmentId:
type: integer
format: int32
example: 33974374
orderId:
type: integer
format: int32
example: 191759016
orderNumber:
type: string
example: 101
userId:
type: string
example: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail:
type: string
example: apisupport@shipstation.com
trackingNumber:
type: string
example: 783408231234
createDate:
type: string
example: 6/7/2016 8:50:50 AM
shipDate:
type: string
example: 6/7/2016 12:00:00 AM
voidDate:
type: string
nullable: true
deliveryDate:
type: string
nullable: true
carrierCode:
type: string
example: USPS
fulfillmentProviderCode:
type: string
nullable: true
fulfillmentServiceCode:
type: string
nullable: true
fulfillmentFee:
type: integer
format: int32
example: 0
voidRequested:
type: boolean
example: false
voided:
type: boolean
example: false
marketplaceNotified:
type: boolean
example: true
notifyErrorMessage:
type: string
nullable: true
shipTo:
$ref: '#/components/schemas/ShipTo'
ShipTo:
title: ShipTo
required:
- name
- street1
- city
- state
- postalCode
- country
- phone
type: object
properties:
name:
type: string
example: Yoda
company:
type: string
nullable: true
street1:
type: string
example: '3800 N Lamar Blvd # 220'
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
example: AUSTIN
state:
type: string
example: TX
postalCode:
type: string
example: 78756
country:
type: string
example: US
phone:
type: string
example: 512-485-4282
residential:
type: string
nullable: true
addressVerified:
type: string
nullable: true
example:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
sortBy1:
title: sortBy1
enum:
- ShipDate
- CreateDate
type: string
example: ShipDate
ListFulfillmentswithparametersresponse:
title: ListFulfillmentswithparametersresponse
required:
- fulfillments
- total
- page
- pages
type: object
properties:
fulfillments:
type: array
items:
$ref: '#/components/schemas/Fulfillment'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
example:
fulfillments:
- fulfillmentId: 33974374
orderId: 191759016
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 783408231234
createDate: 2016-06-07T08:50:50.0670000
shipDate: 2016-06-07T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: USPS
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
- fulfillmentId: 246310
orderId: 193699927
orderNumber: 101
userId: c9f06d74-95de-4263-9b04-e87095cababf
customerEmail: apisupport@shipstation.com
trackingNumber: 664756278745
createDate: 2016-06-08T12:54:53.3470000
shipDate: 2016-06-08T00:00:00.0000000
voidDate:
deliveryDate:
carrierCode: FedEx
fulfillmentProviderCode:
fulfillmentServiceCode:
fulfillmentFee: 0
voidRequested: false
voided: false
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company:
street1: '3800 N Lamar Blvd # 220'
street2:
street3:
city: AUSTIN
state: TX
postalCode: 78756
country: US
phone: 512-485-4282
residential:
addressVerified:
total: 2
page: 1
pages: 0
GetOrderresponse:
title: GetOrderresponse
required:
- orderId
- orderNumber
- orderKey
- orderDate
- createDate
- modifyDate
- paymentDate
- shipByDate
- orderStatus
- customerId
- customerUsername
- customerEmail
- billTo
- shipTo
- items
- orderTotal
- amountPaid
- taxAmount
- shippingAmount
- customerNotes
- internalNotes
- gift
- giftMessage
- paymentMethod
- requestedShippingService
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- insuranceOptions
- internationalOptions
- advancedOptions
- externallyFulfilled
type: object
properties:
orderId:
type: integer
format: int32
orderNumber:
type: string
orderKey:
type: string
orderDate:
type: string
createDate:
type: string
modifyDate:
type: string
paymentDate:
type: string
shipByDate:
type: string
orderStatus:
type: string
customerId:
type: integer
format: int32
customerUsername:
type: string
customerEmail:
type: string
billTo:
$ref: '#/components/schemas/BillTo'
shipTo:
$ref: '#/components/schemas/ShipTo2'
items:
type: array
items:
$ref: '#/components/schemas/Item'
description: ''
orderTotal:
type: number
amountPaid:
type: number
taxAmount:
type: integer
format: int32
shippingAmount:
type: integer
format: int32
customerNotes:
type: string
internalNotes:
type: string
gift:
type: boolean
giftMessage:
type: string
paymentMethod:
type: string
requestedShippingService:
type: string
carrierCode:
type: string
serviceCode:
type: string
packageCode:
type: string
confirmation:
type: string
shipDate:
type: string
holdUntilDate:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions'
internationalOptions:
$ref: '#/components/schemas/InternationalOptions'
advancedOptions:
$ref: '#/components/schemas/AdvancedOptions'
tagIds:
type: string
nullable: true
userId:
type: string
nullable: true
externallyFulfilled:
type: boolean
externallyFulfilledBy:
type: string
nullable: true
BillTo:
title: BillTo
required:
- name
type: object
properties:
name:
type: string
company:
type: string
nullable: true
street1:
type: string
nullable: true
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
nullable: true
state:
type: string
nullable: true
postalCode:
type: string
nullable: true
country:
type: string
nullable: true
phone:
type: string
nullable: true
residential:
type: string
nullable: true
addressVerified:
type: string
nullable: true
example:
name: Sherlock Holmes
company:
street1:
street2:
street3:
city:
state:
postalCode:
country:
phone:
residential:
addressVerified:
ShipTo2:
title: ShipTo2
required:
- name
- company
- street1
- street2
- city
- state
- postalCode
- country
- phone
- residential
- addressVerified
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: boolean
addressVerified:
type: string
example:
name: The President
company: US Govt
street1: 1600 Pennsylvania Ave
street2: Oval Office
street3:
city: Washington
state: DC
postalCode: 20500
country: US
phone: 555-555-5555
residential: false
addressVerified: Address validation warning
Item:
title: Item
required:
- orderItemId
- lineItemKey
- sku
- name
- weight
- quantity
- unitPrice
- warehouseLocation
- options
- productId
- adjustment
- createDate
- modifyDate
type: object
properties:
orderItemId:
type: integer
format: int32
example: 128836912
lineItemKey:
type: string
example: vd08-MSLbtx
sku:
type: string
example: ABC123
name:
type: string
example: 'Test item #1'
imageUrl:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
quantity:
type: integer
format: int32
example: 2
unitPrice:
type: number
example: 99.989999999999995
taxAmount:
type: string
nullable: true
shippingAmount:
type: string
nullable: true
warehouseLocation:
type: string
example: Aisle 1, Bin 7
options:
type: array
items:
$ref: '#/components/schemas/Option'
description: ''
productId:
type: integer
format: int32
example: 7239919
fulfillmentSku:
type: string
nullable: true
adjustment:
type: boolean
example: false
upc:
type: string
nullable: true
createDate:
type: string
example: 7/16/2015 2:00:34 PM
modifyDate:
type: string
example: 7/16/2015 2:00:34 PM
Weight:
title: Weight
required:
- value
- units
type: object
properties:
value:
type: integer
format: int32
example: 24
units:
type: string
example: ounces
example:
value: 24
units: ounces
Option:
title: Option
type: object
properties:
name:
type: string
example: Size
value:
type: string
example: Large
example:
name: Size
value: Large
Dimensions:
title: Dimensions
required:
- units
- length
- width
- height
type: object
properties:
units:
type: string
length:
type: integer
format: int32
width:
type: integer
format: int32
height:
type: integer
format: int32
example:
units: inches
length: 7
width: 5
height: 6
InsuranceOptions:
title: InsuranceOptions
required:
- provider
- insureShipment
- insuredValue
type: object
properties:
provider:
type: string
insureShipment:
type: boolean
insuredValue:
type: integer
format: int32
example:
provider: carrier
insureShipment: true
insuredValue: 200
InternationalOptions:
title: InternationalOptions
type: object
properties:
contents:
type: string
nullable: true
customsItems:
type: string
nullable: true
nonDelivery:
type: string
nullable: true
example:
contents:
customsItems:
nonDelivery:
AdvancedOptions:
title: AdvancedOptions
required:
- warehouseId
- nonMachinable
- saturdayDelivery
- containsAlcohol
- mergedOrSplit
- mergedIds
- storeId
- customField1
- customField2
- customField3
- source
type: object
properties:
warehouseId:
type: integer
format: int32
nonMachinable:
type: boolean
saturdayDelivery:
type: boolean
containsAlcohol:
type: boolean
mergedOrSplit:
type: boolean
mergedIds:
type: array
items:
type: string
description: ''
parentId:
type: string
nullable: true
storeId:
type: integer
format: int32
customField1:
type: string
customField2:
type: string
customField3:
type: string
source:
type: string
billToParty:
type: string
nullable: true
billToAccount:
type: string
nullable: true
billToPostalCode:
type: string
nullable: true
billToCountryCode:
type: string
nullable: true
example:
warehouseId: 98765
nonMachinable: false
saturdayDelivery: false
containsAlcohol: false
mergedOrSplit: false
mergedIds: []
parentId:
storeId: 12345
customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'
customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below
customField3: https://help.shipstation.com/hc/en-us/articles/206639957
source: Webstore
billToParty:
billToAccount:
billToPostalCode:
billToCountryCode:
DeleteOrderresponse:
title: DeleteOrderresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: The requested order has been deleted.
AddTagtoOrderrequest:
title: AddTagtoOrderrequest
required:
- orderId
- tagId
type: object
properties:
orderId:
type: integer
format: int32
tagId:
type: integer
format: int32
example:
orderId: 123456
tagId: 1234
AddTagtoOrderresponse:
title: AddTagtoOrderresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: Tag added successfully.
AssignUsertoOrderrequest:
title: AssignUsertoOrderrequest
required:
- orderIds
- userId
type: object
properties:
orderIds:
type: array
items:
type: integer
format: int32
description: ''
userId:
type: string
example:
orderIds:
- 123456789
- 12345679
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
AssignUsertoOrderresponse:
title: AssignUsertoOrderresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: User assigned successfully.
CreateLabelforOrderrequest:
title: CreateLabelforOrderrequest
required:
- orderId
- carrierCode
- serviceCode
- packageCode
- shipDate
- weight
- testLabel
type: object
properties:
orderId:
type: integer
format: int32
carrierCode:
type: string
serviceCode:
type: string
packageCode:
type: string
confirmation:
type: string
nullable: true
shipDate:
type: string
weight:
$ref: '#/components/schemas/Weight'
dimensions:
type: string
nullable: true
insuranceOptions:
type: string
nullable: true
internationalOptions:
type: string
nullable: true
advancedOptions:
type: string
nullable: true
testLabel:
type: boolean
example:
orderId: 93348442
carrierCode: fedex
serviceCode: fedex_2day
packageCode: package
confirmation:
shipDate: 2014-04-03
weight:
value: 2
units: pounds
dimensions:
insuranceOptions:
internationalOptions:
advancedOptions:
testLabel: false
CreateLabelforOrderresponse:
title: CreateLabelforOrderresponse
required:
- shipmentId
- shipmentCost
- insuranceCost
- trackingNumber
- labelData
type: object
properties:
shipmentId:
type: integer
format: int32
shipmentCost:
type: number
insuranceCost:
type: integer
format: int32
trackingNumber:
type: string
labelData:
type: string
formData:
type: string
nullable: true
example:
shipmentId: 72513480
shipmentCost: 7.2999999999999998
insuranceCost: 0
trackingNumber: 248201115029520
labelData: JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEJDBV0jCz0LBV1jY0M9I4XkXAX9iDRDBZd8hUAuAEdGC7cKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveFswIDAgMjg4IDQzMl0vUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vQ29udGVudHMgMiAwIFIvUGFyZW50....
formData:
Create/UpdateOrderrequest:
title: Create/UpdateOrderrequest
required:
- orderNumber
- orderKey
- orderDate
- paymentDate
- shipByDate
- orderStatus
- customerId
- customerUsername
- customerEmail
- billTo
- shipTo
- items
- amountPaid
- taxAmount
- shippingAmount
- customerNotes
- internalNotes
- gift
- giftMessage
- paymentMethod
- requestedShippingService
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- insuranceOptions
- internationalOptions
- advancedOptions
- tagIds
type: object
properties:
orderNumber:
type: string
orderKey:
type: string
orderDate:
type: string
paymentDate:
type: string
shipByDate:
type: string
orderStatus:
type: string
customerId:
type: integer
format: int32
customerUsername:
type: string
customerEmail:
type: string
billTo:
$ref: '#/components/schemas/BillTo1'
shipTo:
$ref: '#/components/schemas/ShipTo3'
items:
type: array
items:
$ref: '#/components/schemas/Item1'
description: ''
amountPaid:
type: number
taxAmount:
type: integer
format: int32
shippingAmount:
type: integer
format: int32
customerNotes:
type: string
internalNotes:
type: string
gift:
type: boolean
giftMessage:
type: string
paymentMethod:
type: string
requestedShippingService:
type: string
carrierCode:
type: string
serviceCode:
type: string
packageCode:
type: string
confirmation:
type: string
shipDate:
type: string
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions'
internationalOptions:
$ref: '#/components/schemas/InternationalOptions1'
advancedOptions:
$ref: '#/components/schemas/AdvancedOptions'
tagIds:
type: array
items:
type: integer
format: int32
description: ''
BillTo1:
title: BillTo1
required:
- name
type: object
properties:
name:
type: string
company:
type: string
nullable: true
street1:
type: string
nullable: true
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
nullable: true
state:
type: string
nullable: true
postalCode:
type: string
nullable: true
country:
type: string
nullable: true
phone:
type: string
nullable: true
residential:
type: string
nullable: true
example:
name: The President
company:
street1:
street2:
street3:
city:
state:
postalCode:
country:
phone:
residential:
ShipTo3:
title: ShipTo3
required:
- name
- company
- street1
- street2
- city
- state
- postalCode
- country
- phone
- residential
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: boolean
example:
name: The President
company: US Govt
street1: 1600 Pennsylvania Ave
street2: Oval Office
street3:
city: Washington
state: DC
postalCode: 20500
country: US
phone: 555-555-5555
residential: true
Item1:
title: Item1
required:
- lineItemKey
- sku
- name
- weight
- quantity
- unitPrice
- taxAmount
- shippingAmount
- warehouseLocation
- options
- productId
- adjustment
- upc
type: object
properties:
lineItemKey:
type: string
example: vd08-MSLbtx
sku:
type: string
example: ABC123
name:
type: string
example: 'Test item #1'
imageUrl:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
quantity:
type: integer
format: int32
example: 2
unitPrice:
type: number
example: 99.989999999999995
taxAmount:
type: number
example: 2.5
shippingAmount:
type: number
example: 5
warehouseLocation:
type: string
example: Aisle 1, Bin 7
options:
type: array
items:
$ref: '#/components/schemas/Option'
description: ''
productId:
type: integer
format: int32
example: 123456
fulfillmentSku:
type: string
nullable: true
adjustment:
type: boolean
example: false
upc:
type: string
example: 32-65-98
InternationalOptions1:
title: InternationalOptions1
type: object
properties:
contents:
type: string
nullable: true
customsItems:
type: string
nullable: true
example:
contents:
customsItems:
Create/UpdateOrderresponse:
title: Create/UpdateOrderresponse
required:
- orderId
- orderNumber
- orderKey
- orderDate
- createDate
- modifyDate
- paymentDate
- shipByDate
- orderStatus
- customerUsername
- customerEmail
- billTo
- shipTo
- items
- orderTotal
- amountPaid
- taxAmount
- shippingAmount
- customerNotes
- internalNotes
- gift
- giftMessage
- paymentMethod
- requestedShippingService
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- insuranceOptions
- internationalOptions
- advancedOptions
- externallyFulfilled
type: object
properties:
orderId:
type: integer
format: int32
orderNumber:
type: string
orderKey:
type: string
orderDate:
type: string
createDate:
type: string
modifyDate:
type: string
paymentDate:
type: string
shipByDate:
type: string
orderStatus:
type: string
customerId:
type: string
nullable: true
customerUsername:
type: string
customerEmail:
type: string
billTo:
$ref: '#/components/schemas/BillTo'
shipTo:
$ref: '#/components/schemas/ShipTo2'
items:
type: array
items:
$ref: '#/components/schemas/Item2'
description: ''
orderTotal:
type: number
amountPaid:
type: number
taxAmount:
type: integer
format: int32
shippingAmount:
type: integer
format: int32
customerNotes:
type: string
internalNotes:
type: string
gift:
type: boolean
giftMessage:
type: string
paymentMethod:
type: string
requestedShippingService:
type: string
carrierCode:
type: string
serviceCode:
type: string
packageCode:
type: string
confirmation:
type: string
shipDate:
type: string
holdUntilDate:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions'
internationalOptions:
$ref: '#/components/schemas/InternationalOptions'
advancedOptions:
$ref: '#/components/schemas/AdvancedOptions'
tagIds:
type: string
nullable: true
userId:
type: string
nullable: true
externallyFulfilled:
type: boolean
externallyFulfilledBy:
type: string
nullable: true
Item2:
title: Item2
required:
- orderItemId
- lineItemKey
- sku
- name
- weight
- quantity
- unitPrice
- taxAmount
- shippingAmount
- warehouseLocation
- options
- adjustment
- upc
- createDate
- modifyDate
type: object
properties:
orderItemId:
type: integer
format: int32
example: 192210956
lineItemKey:
type: string
example: vd08-MSLbtx
sku:
type: string
example: ABC123
name:
type: string
example: 'Test item #1'
imageUrl:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
quantity:
type: integer
format: int32
example: 2
unitPrice:
type: number
example: 99.989999999999995
taxAmount:
type: number
example: 2.5
shippingAmount:
type: integer
format: int32
example: 5
warehouseLocation:
type: string
example: Aisle 1, Bin 7
options:
type: array
items:
$ref: '#/components/schemas/Option'
description: ''
productId:
type: string
nullable: true
fulfillmentSku:
type: string
nullable: true
adjustment:
type: boolean
example: false
upc:
type: string
example: 32-65-98
createDate:
type: string
example: 2/16/2016 3:16:53 PM
modifyDate:
type: string
example: 2/16/2016 3:16:53 PM
Create/UpdateMultipleOrdersrequest:
title: Create/UpdateMultipleOrdersrequest
required:
- orderNumber
- orderKey
- orderDate
- paymentDate
- shipByDate
- orderStatus
- customerId
- customerUsername
- customerEmail
- billTo
- shipTo
- items
- amountPaid
- taxAmount
- shippingAmount
- customerNotes
- internalNotes
- gift
- giftMessage
- paymentMethod
- requestedShippingService
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- insuranceOptions
- internationalOptions
- advancedOptions
- tagIds
type: object
properties:
orderNumber:
type: string
example: TEST-ORDER-API-DOCS
orderKey:
type: string
example: 0f6bec18-3e89-4881-83aa-f392d84f4c74
orderDate:
type: string
example: 6/29/2015 8:46:27 AM
paymentDate:
type: string
example: 6/29/2015 8:46:27 AM
shipByDate:
type: string
example: 7/5/2015 12:00:00 AM
orderStatus:
type: string
example: awaiting_shipment
customerId:
type: integer
format: int32
example: 37701499
customerUsername:
type: string
example: headhoncho@whitehouse.gov
customerEmail:
type: string
example: headhoncho@whitehouse.gov
billTo:
$ref: '#/components/schemas/BillTo1'
shipTo:
$ref: '#/components/schemas/ShipTo3'
items:
type: array
items:
$ref: '#/components/schemas/Item1'
description: ''
amountPaid:
type: number
example: 218.72999999999999
taxAmount:
type: integer
format: int32
example: 5
shippingAmount:
type: integer
format: int32
example: 10
customerNotes:
type: string
example: Please ship as soon as possible!
internalNotes:
type: string
example: Customer called and would like to upgrade shipping
gift:
type: boolean
example: true
giftMessage:
type: string
example: Thank you!
paymentMethod:
type: string
example: Credit Card
requestedShippingService:
type: string
example: Priority Mail
carrierCode:
type: string
example: fedex
serviceCode:
type: string
example: fedex_2day
packageCode:
type: string
example: package
confirmation:
type: string
example: delivery
shipDate:
type: string
example: 2015-07-02
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions'
internationalOptions:
$ref: '#/components/schemas/InternationalOptions1'
advancedOptions:
$ref: '#/components/schemas/AdvancedOptions'
tagIds:
type: array
items:
type: integer
format: int32
description: ''
Create/UpdateMultipleOrdersresponse:
title: Create/UpdateMultipleOrdersresponse
required:
- hasErrors
- results
type: object
properties:
hasErrors:
type: boolean
results:
type: array
items:
$ref: '#/components/schemas/Result'
description: ''
example:
hasErrors: false
results:
- orderId: 58345234
orderNumber: TEST-ORDER-API-DOCS
orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74
success: true
errorMessage:
Result:
title: Result
required:
- orderId
- orderNumber
- orderKey
- success
type: object
properties:
orderId:
type: integer
format: int32
example: 58345234
orderNumber:
type: string
example: TEST-ORDER-API-DOCS
orderKey:
type: string
example: 0f6bec18-3e89-4881-83aa-f392d84f4c74
success:
type: boolean
example: true
errorMessage:
type: string
nullable: true
HoldOrderUntilrequest:
title: HoldOrderUntilrequest
required:
- orderId
- holdUntilDate
type: object
properties:
orderId:
type: integer
format: int32
holdUntilDate:
type: string
example:
orderId: 1072467
holdUntilDate: 2014-12-01
HoldOrderUntilresponse:
title: HoldOrderUntilresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: Order held successfully.
ListOrdersw/oparametersresponse:
title: ListOrdersw/oparametersresponse
required:
- orders
- total
- page
- pages
type: object
properties:
orders:
type: array
items:
$ref: '#/components/schemas/Order'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
Order:
title: Order
required:
- orderId
- orderNumber
- orderKey
- orderDate
- createDate
- modifyDate
- paymentDate
- shipByDate
- orderStatus
- customerId
- customerUsername
- customerEmail
- billTo
- shipTo
- items
- orderTotal
- amountPaid
- taxAmount
- shippingAmount
- customerNotes
- internalNotes
- gift
- requestedShippingService
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- insuranceOptions
- internationalOptions
- advancedOptions
- externallyFulfilled
type: object
properties:
orderId:
type: integer
format: int32
example: 987654321
orderNumber:
type: string
example: Test-International-API-DOCS
orderKey:
type: string
example: Test-International-API-DOCS
orderDate:
type: string
example: 6/28/2015 5:46:27 PM
createDate:
type: string
example: 8/17/2015 9:24:14 AM
modifyDate:
type: string
example: 8/17/2015 9:24:16 AM
paymentDate:
type: string
example: 6/28/2015 5:46:27 PM
shipByDate:
type: string
example: 7/5/2015 12:00:00 AM
orderStatus:
type: string
example: awaiting_shipment
customerId:
type: integer
format: int32
example: 63310475
customerUsername:
type: string
example: sholmes1854@methodsofdetection.com
customerEmail:
type: string
example: sholmes1854@methodsofdetection.com
billTo:
$ref: '#/components/schemas/BillTo'
shipTo:
$ref: '#/components/schemas/ShipTo6'
items:
type: array
items:
$ref: '#/components/schemas/Item4'
description: ''
orderTotal:
type: number
example: 387.97000000000003
amountPaid:
type: number
example: 412.97000000000003
taxAmount:
type: number
example: 27.989999999999998
shippingAmount:
type: integer
format: int32
example: 35
customerNotes:
type: string
example: Please be careful when packing the disguise kits in with the cane.
internalNotes:
type: string
example: Mr. Holmes called to upgrade his shipping to expedited
gift:
type: boolean
example: false
giftMessage:
type: string
nullable: true
paymentMethod:
type: string
nullable: true
requestedShippingService:
type: string
example: Priority Mail Int
carrierCode:
type: string
example: stamps_com
serviceCode:
type: string
example: usps_priority_mail_international
packageCode:
type: string
example: package
confirmation:
type: string
example: delivery
shipDate:
type: string
example: 2015-04-25
holdUntilDate:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions4'
internationalOptions:
$ref: '#/components/schemas/InternationalOptions4'
advancedOptions:
$ref: '#/components/schemas/AdvancedOptions4'
tagIds:
type: string
nullable: true
userId:
type: string
nullable: true
externallyFulfilled:
type: boolean
example: false
externallyFulfilledBy:
type: string
nullable: true
ShipTo6:
title: ShipTo6
required:
- name
- company
- street1
- street2
- city
- state
- postalCode
- country
- residential
- addressVerified
type: object
properties:
name:
type: string
example: Sherlock Holmes
company:
type: string
street1:
type: string
example: 221 B Baker St
street2:
type: string
street3:
type: string
nullable: true
city:
type: string
example: London
state:
type: string
postalCode:
type: string
example: NW1 6XE
country:
type: string
example: GB
phone:
type: string
nullable: true
residential:
type: boolean
example: true
addressVerified:
type: string
example: Address not yet validated
example:
name: Sherlock Holmes
company: ''
street1: 221 B Baker St
street2: ''
street3:
city: London
state: ''
postalCode: NW1 6XE
country: GB
phone:
residential: true
addressVerified: Address not yet validated
Item4:
title: Item4
required:
- orderItemId
- sku
- name
- weight
- quantity
- unitPrice
- warehouseLocation
- options
- productId
- fulfillmentSku
- adjustment
- createDate
- modifyDate
type: object
properties:
orderItemId:
type: integer
format: int32
example: 136282568
lineItemKey:
type: string
nullable: true
sku:
type: string
example: Ele-1234
name:
type: string
example: Elementary Disguise Kit
imageUrl:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
quantity:
type: integer
format: int32
example: 2
unitPrice:
type: number
example: 49.990000000000002
taxAmount:
type: string
nullable: true
shippingAmount:
type: string
nullable: true
warehouseLocation:
type: string
example: Aisle 1, Bin 7
options:
type: array
items:
$ref: '#/components/schemas/Option'
description: ''
productId:
type: integer
format: int32
example: 11780610
fulfillmentSku:
type: string
example: Ele-1234
adjustment:
type: boolean
example: false
upc:
type: string
nullable: true
createDate:
type: string
example: 8/17/2015 9:24:14 AM
modifyDate:
type: string
example: 8/17/2015 9:24:14 AM
example:
orderItemId: 136282568
lineItemKey: null
sku: Ele-1234
name: Elementary Disguise Kit
imageUrl: null
weight:
value: 12
units: ounces
quantity: 2
unitPrice: 49.990000000000002
taxAmount: null
shippingAmount: null
warehouseLocation: Aisle 1, Bin 7
options: []
productId: 11780610
fulfillmentSku: Ele-1234
adjustment: false
upc: null
createDate: '"2015-08-17T09:24:14.78"'
modifyDate: '"2015-08-17T09:24:14.78"'
InsuranceOptions4:
title: InsuranceOptions4
required:
- insureShipment
- insuredValue
type: object
properties:
provider:
type: string
nullable: true
insureShipment:
type: boolean
example: false
insuredValue:
type: integer
format: int32
example: 0
example:
provider:
insureShipment: false
insuredValue: 0
InternationalOptions4:
title: InternationalOptions4
required:
- contents
- customsItems
- nonDelivery
type: object
properties:
contents:
type: string
example: merchandise
customsItems:
type: array
items:
$ref: '#/components/schemas/CustomsItem'
description: ''
nonDelivery:
type: string
example: return_to_sender
CustomsItem:
title: CustomsItem
required:
- customsItemId
- description
- quantity
- value
- countryOfOrigin
type: object
properties:
customsItemId:
type: integer
format: int32
example: 11558268
description:
type: string
example: Fine White Oak Cane
quantity:
type: integer
format: int32
example: 1
value:
type: integer
format: int32
example: 225
harmonizedTariffCode:
type: string
nullable: true
countryOfOrigin:
type: string
example: US
AdvancedOptions4:
title: AdvancedOptions4
required:
- warehouseId
- nonMachinable
- saturdayDelivery
- containsAlcohol
- mergedOrSplit
- mergedIds
- storeId
- customField1
- customField2
type: object
properties:
warehouseId:
type: integer
format: int32
example: 98765
nonMachinable:
type: boolean
example: false
saturdayDelivery:
type: boolean
example: false
containsAlcohol:
type: boolean
example: false
mergedOrSplit:
type: boolean
example: false
mergedIds:
type: array
items:
type: string
description: ''
parentId:
type: string
nullable: true
storeId:
type: integer
format: int32
example: 12345
customField1:
type: string
example: 'SKU: CN-9876 x 1'
customField2:
type: string
example: 'SKU: Ele-123 x 2'
customField3:
type: string
nullable: true
source:
type: string
nullable: true
billToParty:
type: string
nullable: true
billToAccount:
type: string
nullable: true
billToPostalCode:
type: string
nullable: true
billToCountryCode:
type: string
nullable: true
example:
warehouseId: 98765
nonMachinable: false
saturdayDelivery: false
containsAlcohol: false
mergedOrSplit: false
mergedIds: []
parentId:
storeId: 12345
customField1: 'SKU: CN-9876 x 1'
customField2: 'SKU: Ele-123 x 2'
customField3:
source:
billToParty:
billToAccount:
billToPostalCode:
billToCountryCode:
orderStatus:
title: orderStatus
enum:
- awaiting_payment
- awaiting_shipment
- pending_fulfillment
- shipped
- on_hold
- cancelled
type: string
example: awaiting_payment
sortBy2:
title: sortBy2
enum:
- OrderDate
- ModifyDate
- CreateDate
type: string
example: OrderDate
ListOrderswithparametersresponse:
title: ListOrderswithparametersresponse
required:
- orders
- total
- page
- pages
type: object
properties:
orders:
type: array
items:
$ref: '#/components/schemas/Order'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
ListOrdersbyTagresponse:
title: ListOrdersbyTagresponse
required:
- orders
- total
- page
- pages
type: object
properties:
orders:
type: array
items:
$ref: '#/components/schemas/Order2'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
Order2:
title: Order2
required:
- orderId
- orderNumber
- orderKey
- orderDate
- createDate
- modifyDate
- paymentDate
- shipByDate
- orderStatus
- customerId
- customerUsername
- customerEmail
- billTo
- shipTo
- items
- orderTotal
- amountPaid
- taxAmount
- shippingAmount
- customerNotes
- internalNotes
- gift
- giftMessage
- paymentMethod
- requestedShippingService
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- insuranceOptions
- internationalOptions
- advancedOptions
- tagIds
- userId
- externallyFulfilled
type: object
properties:
orderId:
type: integer
format: int32
example: 123456789
orderNumber:
type: string
example: TEST-ORDER-API-DOCS
orderKey:
type: string
example: 0f6bec18-3e89-4881-83aa-f392d84f4c74
orderDate:
type: string
example: 6/29/2015 8:46:27 AM
createDate:
type: string
example: 8/17/2015 9:43:03 AM
modifyDate:
type: string
example: 8/17/2015 9:43:12 AM
paymentDate:
type: string
example: 6/29/2015 8:46:27 AM
shipByDate:
type: string
example: 7/5/2015 12:00:00 AM
orderStatus:
type: string
example: awaiting_shipment
customerId:
type: integer
format: int32
example: 37701499
customerUsername:
type: string
example: headhoncho@whitehouse.gov
customerEmail:
type: string
example: headhoncho@whitehouse.gov
billTo:
$ref: '#/components/schemas/BillTo'
shipTo:
$ref: '#/components/schemas/ShipTo2'
items:
type: array
items:
$ref: '#/components/schemas/Item6'
description: ''
orderTotal:
type: number
example: 194.43000000000001
amountPaid:
type: number
example: 218.72999999999999
taxAmount:
type: integer
format: int32
example: 5
shippingAmount:
type: integer
format: int32
example: 10
customerNotes:
type: string
example: Please ship as soon as possible!
internalNotes:
type: string
example: Customer called and would like to upgrade shipping
gift:
type: boolean
example: true
giftMessage:
type: string
example: Thank you!
paymentMethod:
type: string
example: Credit Card
requestedShippingService:
type: string
example: Priority Mail
carrierCode:
type: string
example: fedex
serviceCode:
type: string
example: fedex_2day
packageCode:
type: string
example: package
confirmation:
type: string
example: delivery
shipDate:
type: string
example: 2015-07-02
holdUntilDate:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions'
internationalOptions:
$ref: '#/components/schemas/InternationalOptions'
advancedOptions:
$ref: '#/components/schemas/AdvancedOptions'
tagIds:
type: array
items:
type: integer
format: int32
description: ''
userId:
type: string
example: b854f701-e0c2-4156-90fe-19c77cdef27c
externallyFulfilled:
type: boolean
example: false
externallyFulfilledBy:
type: string
nullable: true
Item6:
title: Item6
required:
- orderItemId
- lineItemKey
- sku
- name
- weight
- quantity
- unitPrice
- taxAmount
- shippingAmount
- warehouseLocation
- options
- productId
- adjustment
- upc
- createDate
- modifyDate
type: object
properties:
orderItemId:
type: integer
format: int32
example: 136289188
lineItemKey:
type: string
example: vd08-MSLbtx
sku:
type: string
example: ABC123
name:
type: string
example: 'Test item #1'
imageUrl:
type: string
nullable: true
weight:
$ref: '#/components/schemas/Weight'
quantity:
type: integer
format: int32
example: 2
unitPrice:
type: number
example: 99.989999999999995
taxAmount:
type: number
example: 2.5
shippingAmount:
type: integer
format: int32
example: 5
warehouseLocation:
type: string
example: Aisle 1, Bin 7
options:
type: array
items:
$ref: '#/components/schemas/Option'
description: ''
productId:
type: integer
format: int32
example: 7239919
fulfillmentSku:
type: string
nullable: true
adjustment:
type: boolean
example: false
upc:
type: string
example: 32-65-98
createDate:
type: string
example: 8/17/2015 9:43:03 AM
modifyDate:
type: string
example: 8/17/2015 9:43:03 AM
MarkanOrderasShippedrequest:
title: MarkanOrderasShippedrequest
required:
- orderId
- carrierCode
- shipDate
- trackingNumber
- notifyCustomer
- notifySalesChannel
type: object
properties:
orderId:
type: integer
format: int32
carrierCode:
type: string
shipDate:
type: string
trackingNumber:
type: string
notifyCustomer:
type: boolean
notifySalesChannel:
type: boolean
example:
orderId: 93348442
carrierCode: usps
shipDate: 2014-04-01
trackingNumber: 913492493294329421
notifyCustomer: true
notifySalesChannel: true
MarkanOrderasShippedresponse:
title: MarkanOrderasShippedresponse
required:
- orderId
- orderNumber
type: object
properties:
orderId:
type: integer
format: int32
orderNumber:
type: string
example:
orderId: 123456789
orderNumber: ABC123
RemoveTagfromOrderrequest:
title: RemoveTagfromOrderrequest
required:
- orderId
- tagId
type: object
properties:
orderId:
type: integer
format: int32
tagId:
type: integer
format: int32
example:
orderId: 123456
tagId: 1234
RemoveTagfromOrderresponse:
title: RemoveTagfromOrderresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: Tag removed successfully.
RestoreOrderfromOnHoldrequest:
title: RestoreOrderfromOnHoldrequest
required:
- orderId
type: object
properties:
orderId:
type: integer
format: int32
example:
orderId: 1234567
RestoreOrderfromOnHoldresponse:
title: RestoreOrderfromOnHoldresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: The requested order has been restored
UnassignUserfromOrderrequest:
title: UnassignUserfromOrderrequest
required:
- orderIds
type: object
properties:
orderIds:
type: array
items:
type: integer
format: int32
description: ''
example:
orderIds:
- 123456789
- 12345679
UnassignUserfromOrderresponse:
title: UnassignUserfromOrderresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: User unassigned successfully.
GetProductresponse:
title: GetProductresponse
required:
- productId
- sku
- name
- price
- defaultCost
- length
- width
- height
- weightOz
- fulfillmentSku
- createDate
- modifyDate
- active
- productCategory
- warehouseLocation
- defaultCarrierCode
- defaultServiceCode
- defaultPackageCode
- defaultIntlCarrierCode
- defaultIntlServiceCode
- defaultIntlPackageCode
- defaultConfirmation
- defaultIntlConfirmation
- tags
type: object
properties:
aliases:
type: string
nullable: true
productId:
type: integer
format: int32
sku:
type: string
name:
type: string
price:
type: integer
format: int32
defaultCost:
type: integer
format: int32
length:
type: integer
format: int32
width:
type: integer
format: int32
height:
type: integer
format: int32
weightOz:
type: integer
format: int32
internalNotes:
type: string
nullable: true
fulfillmentSku:
type: string
createDate:
type: string
modifyDate:
type: string
active:
type: boolean
productCategory:
$ref: '#/components/schemas/ProductCategory'
productType:
type: string
nullable: true
warehouseLocation:
type: string
defaultCarrierCode:
type: string
defaultServiceCode:
type: string
defaultPackageCode:
type: string
defaultIntlCarrierCode:
type: string
defaultIntlServiceCode:
type: string
defaultIntlPackageCode:
type: string
defaultConfirmation:
type: string
defaultIntlConfirmation:
type: string
customsDescription:
type: string
nullable: true
customsValue:
type: string
nullable: true
customsTariffNo:
type: string
nullable: true
customsCountryCode:
type: string
nullable: true
noCustoms:
type: string
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
example:
aliases:
productId: 12345678
sku: 1004
name: Coffee Mug
price: 26
defaultCost: 0
length: 3
width: 3
height: 3
weightOz: 26
internalNotes:
fulfillmentSku: F1004
createDate: 2014-09-04T09:18:01.2930000
modifyDate: 2014-09-18T12:38:43.8930000
active: true
productCategory:
categoryId: 9999
name: Door Closers
productType:
warehouseLocation: Bin 22
defaultCarrierCode: fedex
defaultServiceCode: fedex_home_delivery
defaultPackageCode: package
defaultIntlCarrierCode: ups
defaultIntlServiceCode: ups_worldwide_saver
defaultIntlPackageCode: package
defaultConfirmation: direct_signature
defaultIntlConfirmation: adult_signature
customsDescription:
customsValue:
customsTariffNo:
customsCountryCode:
noCustoms:
tags:
- tagId: 9180
name: APItest
ProductCategory:
title: ProductCategory
required:
- categoryId
- name
type: object
properties:
categoryId:
type: integer
format: int32
name:
type: string
example:
categoryId: 9999
name: Door Closers
UpdateProductrequest:
title: UpdateProductrequest
required:
- productId
- sku
- name
- price
- active
type: object
properties:
aliases:
type: string
nullable: true
productId:
type: integer
format: int32
sku:
type: string
name:
type: string
price:
type: integer
format: int32
defaultCost:
type: string
nullable: true
length:
type: string
nullable: true
width:
type: string
nullable: true
height:
type: string
nullable: true
weightOz:
type: string
nullable: true
internalNotes:
type: string
nullable: true
fulfillmentSku:
type: string
nullable: true
active:
type: boolean
productCategory:
type: string
nullable: true
productType:
type: string
nullable: true
warehouseLocation:
type: string
nullable: true
defaultCarrierCode:
type: string
nullable: true
defaultServiceCode:
type: string
nullable: true
defaultPackageCode:
type: string
nullable: true
defaultIntlCarrierCode:
type: string
nullable: true
defaultIntlServiceCode:
type: string
nullable: true
defaultIntlPackageCode:
type: string
nullable: true
defaultConfirmation:
type: string
nullable: true
defaultIntlConfirmation:
type: string
nullable: true
customsDescription:
type: string
nullable: true
customsValue:
type: string
nullable: true
customsTariffNo:
type: string
nullable: true
customsCountryCode:
type: string
nullable: true
noCustoms:
type: string
nullable: true
tags:
type: string
nullable: true
example:
aliases:
productId: 123456789
sku: ''
name: Beautiful
price: 0
defaultCost:
length:
width:
height:
weightOz:
internalNotes:
fulfillmentSku:
active: true
productCategory:
productType:
warehouseLocation:
defaultCarrierCode:
defaultServiceCode:
defaultPackageCode:
defaultIntlCarrierCode:
defaultIntlServiceCode:
defaultIntlPackageCode:
defaultConfirmation:
defaultIntlConfirmation:
customsDescription:
customsValue:
customsTariffNo:
customsCountryCode:
noCustoms:
tags:
UpdateProductresponse:
title: UpdateProductresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: The requested product has been updated
ListProductsw/oparametersresponse:
title: ListProductsw/oparametersresponse
required:
- products
- total
- page
- pages
type: object
properties:
products:
type: array
items:
$ref: '#/components/schemas/Product'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
Product:
title: Product
required:
- productId
- sku
- name
- price
- defaultCost
- length
- width
- height
- weightOz
- fulfillmentSku
- createDate
- modifyDate
- active
- productCategory
- warehouseLocation
- defaultCarrierCode
- defaultServiceCode
- defaultPackageCode
- defaultIntlCarrierCode
- defaultIntlServiceCode
- defaultIntlPackageCode
- defaultConfirmation
- defaultIntlConfirmation
- tags
type: object
properties:
aliases:
type: string
nullable: true
productId:
type: integer
format: int32
example: 7854008
sku:
type: string
example: 1004
name:
type: string
example: Coffee Mug
price:
type: integer
format: int32
example: 26
defaultCost:
type: integer
format: int32
example: 0
length:
type: integer
format: int32
example: 3
width:
type: integer
format: int32
example: 3
height:
type: integer
format: int32
example: 3
weightOz:
type: integer
format: int32
example: 26
internalNotes:
type: string
nullable: true
fulfillmentSku:
type: string
example: F1004
createDate:
type: string
example: 9/4/2014 9:18:01 AM
modifyDate:
type: string
example: 9/18/2014 12:38:43 PM
active:
type: boolean
example: true
productCategory:
$ref: '#/components/schemas/ProductCategory'
productType:
type: string
nullable: true
warehouseLocation:
type: string
example: Bin 22
defaultCarrierCode:
type: string
example: fedex
defaultServiceCode:
type: string
example: fedex_home_delivery
defaultPackageCode:
type: string
example: package
defaultIntlCarrierCode:
type: string
example: ups
defaultIntlServiceCode:
type: string
example: ups_worldwide_saver
defaultIntlPackageCode:
type: string
example: package
defaultConfirmation:
type: string
example: direct_signature
defaultIntlConfirmation:
type: string
example: adult_signature
customsDescription:
type: string
nullable: true
customsValue:
type: string
nullable: true
customsTariffNo:
type: string
nullable: true
customsCountryCode:
type: string
nullable: true
noCustoms:
type: string
nullable: true
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
sortBy3:
title: sortBy3
enum:
- SKU
- ModifyDate
- CreateDate
type: string
example: SKU
ListProductswithparametersresponse:
title: ListProductswithparametersresponse
required:
- products
- total
- page
- pages
type: object
properties:
products:
type: array
items:
$ref: '#/components/schemas/Product'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
ListShipmentsw/oparametersresponse:
title: ListShipmentsw/oparametersresponse
required:
- shipments
- total
- page
- pages
type: object
properties:
shipments:
type: array
items:
$ref: '#/components/schemas/Shipment'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
example:
shipments:
- shipmentId: 33974374
orderId: 43945660
orderKey: 8061c220f0794a9b92460b8bae6837e4
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100038-1
createDate: 2014-10-03T06:51:33.6270000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681189
isReturnLabel: false
batchNumber: 100301
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 16079
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company: ''
street1: 12223 LOWDEN LN
street2: ''
street3:
city: MANCHACA
state: TX
postalCode: 78652-3602
country: US
phone: 2101235544
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 56568665
lineItemKey:
sku: SQ3785739
name: Potato Kitten -
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7565777
fulfillmentSku:
labelData:
formData:
- shipmentId: 33974373
orderId: 43337328
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100028
createDate: 2014-10-03T06:51:59.9430000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681196
isReturnLabel: false
batchNumber: 100300
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 14265
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Luke Skywalker
company: SS
street1: 2815 EXPOSITION BLVD
street2: ''
street3:
city: AUSTIN
state: TX
postalCode: 78703-1221
country: US
phone: ''
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 55827278
lineItemKey:
sku: test
name: test
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7541107
fulfillmentSku:
labelData:
formData:
total: 2
page: 1
pages: 0
Shipment:
title: Shipment
required:
- shipmentId
- orderId
- userId
- orderNumber
- createDate
- shipDate
- shipmentCost
- insuranceCost
- trackingNumber
- isReturnLabel
- batchNumber
- carrierCode
- serviceCode
- packageCode
- confirmation
- warehouseId
- voided
- marketplaceNotified
- shipTo
- weight
- insuranceOptions
- shipmentItems
type: object
properties:
shipmentId:
type: integer
format: int32
example: 33974374
orderId:
type: integer
format: int32
example: 43945660
orderKey:
type: string
example: 8061c220f0794a9b92460b8bae6837e4
userId:
type: string
example: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber:
type: string
example: 100038-1
createDate:
type: string
example: 10/3/2014 6:51:33 AM
shipDate:
type: string
example: 2014-10-03
shipmentCost:
type: number
example: 1.9299999999999999
insuranceCost:
type: integer
format: int32
example: 0
trackingNumber:
type: string
example: 9400111899561704681189
isReturnLabel:
type: boolean
example: false
batchNumber:
type: string
example: 100301
carrierCode:
type: string
example: stamps_com
serviceCode:
type: string
example: usps_first_class_mail
packageCode:
type: string
example: package
confirmation:
type: string
example: delivery
warehouseId:
type: integer
format: int32
example: 16079
voided:
type: boolean
example: false
voidDate:
type: string
nullable: true
marketplaceNotified:
type: boolean
example: true
notifyErrorMessage:
type: string
nullable: true
shipTo:
$ref: '#/components/schemas/ShipTo9'
weight:
$ref: '#/components/schemas/Weight'
dimensions:
type: string
nullable: true
insuranceOptions:
$ref: '#/components/schemas/InsuranceOptions4'
advancedOptions:
type: string
nullable: true
shipmentItems:
type: array
items:
$ref: '#/components/schemas/ShipmentItem'
description: ''
labelData:
type: string
nullable: true
formData:
type: string
nullable: true
ShipTo9:
title: ShipTo9
required:
- name
- company
- street1
- street2
- city
- state
- postalCode
- country
- phone
type: object
properties:
name:
type: string
example: Yoda
company:
type: string
street1:
type: string
example: 12223 LOWDEN LN
street2:
type: string
street3:
type: string
nullable: true
city:
type: string
example: MANCHACA
state:
type: string
example: TX
postalCode:
type: string
example: 78652-3602
country:
type: string
example: US
phone:
type: string
example: 2101235544
residential:
type: string
nullable: true
example:
name: Yoda
company: ''
street1: 12223 LOWDEN LN
street2: ''
street3:
city: MANCHACA
state: TX
postalCode: 78652-3602
country: US
phone: 2101235544
residential:
ShipmentItem:
title: ShipmentItem
required:
- orderItemId
- sku
- name
- quantity
- unitPrice
- productId
type: object
properties:
orderItemId:
type: integer
format: int32
example: 56568665
lineItemKey:
type: string
nullable: true
sku:
type: string
example: SQ3785739
name:
type: string
example: Potato Kitten -
imageUrl:
type: string
nullable: true
weight:
type: string
nullable: true
quantity:
type: integer
format: int32
example: 1
unitPrice:
type: integer
format: int32
example: 1
warehouseLocation:
type: string
nullable: true
options:
type: string
nullable: true
productId:
type: integer
format: int32
example: 7565777
fulfillmentSku:
type: string
nullable: true
example:
orderItemId: 56568665
lineItemKey:
sku: SQ3785739
name: Potato Kitten -
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7565777
fulfillmentSku:
ListShipmentswithparametersresponse:
title: ListShipmentswithparametersresponse
required:
- shipments
- total
- page
- pages
type: object
properties:
shipments:
type: array
items:
$ref: '#/components/schemas/Shipment'
description: ''
total:
type: integer
format: int32
page:
type: integer
format: int32
pages:
type: integer
format: int32
example:
shipments:
- shipmentId: 33974374
orderId: 43945660
orderKey: 8061c220f0794a9b92460b8bae6837e4
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100038-1
createDate: 2014-10-03T06:51:33.6270000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681189
isReturnLabel: false
batchNumber: 100301
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 16079
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Yoda
company: ''
street1: 12223 LOWDEN LN
street2: ''
street3:
city: MANCHACA
state: TX
postalCode: 78652-3602
country: US
phone: 2101235544
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 56568665
lineItemKey:
sku: SQ3785739
name: Potato Kitten -
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7565777
fulfillmentSku:
labelData:
formData:
- shipmentId: 33974373
orderId: 43337328
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
orderNumber: 100028
createDate: 2014-10-03T06:51:59.9430000
shipDate: 2014-10-03
shipmentCost: 1.9299999999999999
insuranceCost: 0
trackingNumber: 9400111899561704681196
isReturnLabel: false
batchNumber: 100300
carrierCode: stamps_com
serviceCode: usps_first_class_mail
packageCode: package
confirmation: delivery
warehouseId: 14265
voided: false
voidDate:
marketplaceNotified: true
notifyErrorMessage:
shipTo:
name: Luke Skywalker
company: SS
street1: 2815 EXPOSITION BLVD
street2: ''
street3:
city: AUSTIN
state: TX
postalCode: 78703-1221
country: US
phone: ''
residential:
weight:
value: 1
units: ounces
dimensions:
insuranceOptions:
provider:
insureShipment: false
insuredValue: 0
advancedOptions:
shipmentItems:
- orderItemId: 55827278
lineItemKey:
sku: test
name: test
imageUrl:
weight:
quantity: 1
unitPrice: 1
warehouseLocation:
options:
productId: 7541107
fulfillmentSku:
labelData:
formData:
total: 2
page: 1
pages: 0
CreateShipmentLabelrequest:
title: CreateShipmentLabelrequest
required:
- carrierCode
- serviceCode
- packageCode
- confirmation
- shipDate
- weight
- dimensions
- shipFrom
- shipTo
- testLabel
type: object
properties:
carrierCode:
type: string
serviceCode:
type: string
packageCode:
type: string
confirmation:
type: string
shipDate:
type: string
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
shipFrom:
$ref: '#/components/schemas/ShipFrom'
shipTo:
$ref: '#/components/schemas/ShipTo11'
insuranceOptions:
type: string
nullable: true
internationalOptions:
type: string
nullable: true
advancedOptions:
type: string
nullable: true
testLabel:
type: boolean
example:
carrierCode: fedex
serviceCode: fedex_ground
packageCode: package
confirmation: delivery
shipDate: 2014-04-03
weight:
value: 3
units: ounces
dimensions:
units: inches
length: 7
width: 5
height: 6
shipFrom:
name: Jason Hodges
company: ShipStation
street1: 2815 Exposition Blvd
street2: Ste 2353242
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone:
residential: false
shipTo:
name: The President
company: US Govt
street1: 1600 Pennsylvania Ave
street2: Oval Office
street3:
city: Washington
state: DC
postalCode: 20500
country: US
phone:
residential: false
insuranceOptions:
internationalOptions:
advancedOptions:
testLabel: false
ShipFrom:
title: ShipFrom
required:
- name
- company
- street1
- street2
- city
- state
- postalCode
- country
- residential
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
nullable: true
residential:
type: boolean
ShipTo11:
title: ShipTo11
required:
- name
- company
- street1
- street2
- city
- state
- postalCode
- country
- residential
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
nullable: true
residential:
type: boolean
CreateShipmentLabelresponse:
title: CreateShipmentLabelresponse
required:
- shipmentId
- createDate
- shipDate
- shipmentCost
- insuranceCost
- trackingNumber
- isReturnLabel
- carrierCode
- serviceCode
- packageCode
- confirmation
- voided
- marketplaceNotified
- labelData
type: object
properties:
shipmentId:
type: integer
format: int32
orderId:
type: string
nullable: true
userId:
type: string
nullable: true
customerEmail:
type: string
nullable: true
orderNumber:
type: string
nullable: true
createDate:
type: string
shipDate:
type: string
shipmentCost:
type: number
insuranceCost:
type: integer
format: int32
trackingNumber:
type: string
isReturnLabel:
type: boolean
batchNumber:
type: string
nullable: true
carrierCode:
type: string
serviceCode:
type: string
packageCode:
type: string
confirmation:
type: string
warehouseId:
type: string
nullable: true
voided:
type: boolean
voidDate:
type: string
nullable: true
marketplaceNotified:
type: boolean
notifyErrorMessage:
type: string
nullable: true
shipTo:
type: string
nullable: true
weight:
type: string
nullable: true
dimensions:
type: string
nullable: true
insuranceOptions:
type: string
nullable: true
advancedOptions:
type: string
nullable: true
shipmentItems:
type: string
nullable: true
labelData:
type: string
formData:
type: string
nullable: true
example:
shipmentId: 123456789
orderId:
userId:
customerEmail:
orderNumber:
createDate: 2016-04-03T12:11:36.8630000
shipDate: 2016-04-03
shipmentCost: 9.0600000000000005
insuranceCost: 0
trackingNumber: 782390443992
isReturnLabel: false
batchNumber:
carrierCode: fedex
serviceCode: fedex_ground
packageCode: package
confirmation: delivery
warehouseId:
voided: false
voidDate:
marketplaceNotified: false
notifyErrorMessage:
shipTo:
weight:
dimensions:
insuranceOptions:
advancedOptions:
shipmentItems:
labelData: JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2U...
formData:
GetRatesrequest:
title: GetRatesrequest
required:
- carrierCode
- fromPostalCode
- toState
- toCountry
- toPostalCode
- toCity
- weight
- dimensions
- confirmation
- residential
type: object
properties:
carrierCode:
type: string
serviceCode:
type: string
nullable: true
packageCode:
type: string
nullable: true
fromPostalCode:
type: string
toState:
type: string
toCountry:
type: string
toPostalCode:
type: string
toCity:
type: string
weight:
$ref: '#/components/schemas/Weight'
dimensions:
$ref: '#/components/schemas/Dimensions'
confirmation:
type: string
residential:
type: boolean
example:
carrierCode: fedex
serviceCode:
packageCode:
fromPostalCode: 78703
toState: DC
toCountry: US
toPostalCode: 20500
toCity: Washington
weight:
value: 3
units: ounces
dimensions:
units: inches
length: 7
width: 5
height: 6
confirmation: delivery
residential: false
GetRatesresponse:
title: GetRatesresponse
required:
- serviceName
- serviceCode
- shipmentCost
- otherCost
type: object
properties:
serviceName:
type: string
example: FedEx First Overnight®
serviceCode:
type: string
example: fedex_first_overnight
shipmentCost:
type: number
example: 87.799999999999997
otherCost:
type: number
example: 2.6299999999999999
example:
serviceName: FedEx First Overnight®
serviceCode: fedex_first_overnight
shipmentCost: 87.799999999999997
otherCost: 2.6299999999999999
VoidLabelrequest:
title: VoidLabelrequest
required:
- shipmentId
type: object
properties:
shipmentId:
type: integer
format: int32
example:
shipmentId: 12345
VoidLabelresponse:
title: VoidLabelresponse
required:
- approved
- message
type: object
properties:
approved:
type: boolean
message:
type: string
example:
approved: true
message: Label voided successfully
GetStoreresponse:
title: GetStoreresponse
required:
- storeId
- storeName
- marketplaceId
- marketplaceName
- integrationUrl
- active
- companyName
- phone
- publicEmail
- website
- refreshDate
- lastRefreshAttempt
- createDate
- modifyDate
- autoRefresh
- statusMappings
type: object
properties:
storeId:
type: integer
format: int32
storeName:
type: string
marketplaceId:
type: integer
format: int32
marketplaceName:
type: string
accountName:
type: string
nullable: true
email:
type: string
nullable: true
integrationUrl:
type: string
active:
type: boolean
companyName:
type: string
phone:
type: string
publicEmail:
type: string
website:
type: string
refreshDate:
type: string
lastRefreshAttempt:
type: string
createDate:
type: string
modifyDate:
type: string
autoRefresh:
type: boolean
statusMappings:
type: array
items:
$ref: '#/components/schemas/StatusMapping'
description: ''
example:
storeId: 12345
storeName: WooCommerce Store
marketplaceId: 36
marketplaceName: WooCommerce
accountName:
email:
integrationUrl: http://shipstation-test.wpengine.com
active: true
companyName: ''
phone: ''
publicEmail: ''
website: ''
refreshDate: 2014-12-16T17:47:05.4570000
lastRefreshAttempt: 2014-12-16T09:47:05.4570000
createDate: 2014-11-06T15:21:13.2230000
modifyDate: 2014-11-10T08:02:19.1170000
autoRefresh: true
statusMappings:
- orderStatus: awaiting_payment
statusKey: Pending
- orderStatus: awaiting_shipment
statusKey: Processing
- orderStatus: shipped
statusKey: Completed
- orderStatus: cancelled
statusKey: Cancelled
- orderStatus: on_hold
statusKey: On-hold
StatusMapping:
title: StatusMapping
required:
- orderStatus
- statusKey
type: object
properties:
orderStatus:
type: string
example: awaiting_payment
statusKey:
type: string
example: Pending
UpdateStorerequest:
title: UpdateStorerequest
required:
- storeId
- storeName
- marketplaceId
- marketplaceName
- integrationUrl
- active
- companyName
- phone
- publicEmail
- website
- refreshDate
- lastRefreshAttempt
- createDate
- modifyDate
- autoRefresh
- statusMappings
type: object
properties:
storeId:
type: integer
format: int32
storeName:
type: string
marketplaceId:
type: integer
format: int32
marketplaceName:
type: string
accountName:
type: string
nullable: true
email:
type: string
nullable: true
integrationUrl:
type: string
active:
type: boolean
companyName:
type: string
phone:
type: string
publicEmail:
type: string
website:
type: string
refreshDate:
type: string
lastRefreshAttempt:
type: string
createDate:
type: string
modifyDate:
type: string
autoRefresh:
type: boolean
statusMappings:
type: array
items:
$ref: '#/components/schemas/StatusMapping'
description: ''
example:
storeId: 12345
storeName: WooCommerce Store
marketplaceId: 36
marketplaceName: WooCommerce
accountName:
email:
integrationUrl: http://shipstation-test.wpengine.com
active: true
companyName: ''
phone: ''
publicEmail: ''
website: ''
refreshDate: 2014-12-16T17:47:05.4570000
lastRefreshAttempt: 2014-12-16T09:47:05.4570000
createDate: 2014-11-06T15:21:13.2230000
modifyDate: 2014-11-10T08:02:19.1170000
autoRefresh: true
statusMappings:
- orderStatus: awaiting_payment
statusKey: Pending
- orderStatus: awaiting_shipment
statusKey: Processing
- orderStatus: shipped
statusKey: Completed
- orderStatus: cancelled
statusKey: Cancelled
- orderStatus: on_hold
statusKey: On-hold
UpdateStoreresponse:
title: UpdateStoreresponse
required:
- storeId
- storeName
- marketplaceId
- marketplaceName
- integrationUrl
- active
- companyName
- phone
- publicEmail
- website
- refreshDate
- lastRefreshAttempt
- createDate
- modifyDate
- autoRefresh
- statusMappings
type: object
properties:
storeId:
type: integer
format: int32
storeName:
type: string
marketplaceId:
type: integer
format: int32
marketplaceName:
type: string
accountName:
type: string
nullable: true
email:
type: string
nullable: true
integrationUrl:
type: string
active:
type: boolean
companyName:
type: string
phone:
type: string
publicEmail:
type: string
website:
type: string
refreshDate:
type: string
lastRefreshAttempt:
type: string
createDate:
type: string
modifyDate:
type: string
autoRefresh:
type: boolean
statusMappings:
type: array
items:
$ref: '#/components/schemas/StatusMapping'
description: ''
example:
storeId: 12345
storeName: WooCommerce Store
marketplaceId: 36
marketplaceName: WooCommerce
accountName:
email:
integrationUrl: http://shipstation-test.wpengine.com
active: true
companyName: ''
phone: ''
publicEmail: ''
website: ''
refreshDate: 2014-12-16T17:47:05.4570000
lastRefreshAttempt: 2014-12-16T09:47:05.4570000
createDate: 2014-11-06T15:21:13.2230000
modifyDate: 2014-11-10T08:02:19.1170000
autoRefresh: true
statusMappings:
- orderStatus: awaiting_payment
statusKey: Pending
- orderStatus: awaiting_shipment
statusKey: Processing
- orderStatus: shipped
statusKey: Completed
- orderStatus: cancelled
statusKey: Cancelled
- orderStatus: on_hold
statusKey: On-hold
GetStoreRefreshStatusresponse:
title: GetStoreRefreshStatusresponse
required:
- storeId
- refreshStatusId
- refreshStatus
- lastRefreshAttempt
- refreshDate
type: object
properties:
storeId:
type: integer
format: int32
refreshStatusId:
type: integer
format: int32
refreshStatus:
type: string
lastRefreshAttempt:
type: string
refreshDate:
type: string
example:
storeId: 12345
refreshStatusId: 2
refreshStatus: Updating orders
lastRefreshAttempt: 8-13-2014
refreshDate: 8-13-2014
RefreshStorerequest:
title: RefreshStorerequest
required:
- storeId
- refreshDate
type: object
properties:
storeId:
type: integer
format: int32
refreshDate:
type: string
example:
storeId: 12345
refreshDate: 12-08-2014
RefreshStoreresponse:
title: RefreshStoreresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: A store refresh has been initiated for Store ID 12345
ListStoresresponse:
title: ListStoresresponse
required:
- storeId
- storeName
- marketplaceId
- marketplaceName
- active
- companyName
- phone
- publicEmail
- website
- refreshDate
- lastRefreshAttempt
- createDate
- modifyDate
- autoRefresh
type: object
properties:
storeId:
type: integer
format: int32
example: 22766
storeName:
type: string
example: ShipStation Manual Store
marketplaceId:
type: integer
format: int32
example: 0
marketplaceName:
type: string
example: ShipStation
accountName:
type: string
nullable: true
email:
type: string
nullable: true
integrationUrl:
type: string
nullable: true
active:
type: boolean
example: true
companyName:
type: string
phone:
type: string
publicEmail:
type: string
example: testemail@email.com
website:
type: string
refreshDate:
type: string
example: 12/3/2014 11:46:11 AM
lastRefreshAttempt:
type: string
example: 12/3/2014 11:46:53 AM
createDate:
type: string
example: 7/25/2014 11:05:55 AM
modifyDate:
type: string
example: 11/12/2014 8:45:20 AM
autoRefresh:
type: boolean
example: false
example:
storeId: 22766
storeName: ShipStation Manual Store
marketplaceId: 0
marketplaceName: ShipStation
accountName:
email:
integrationUrl:
active: true
companyName: ''
phone: ''
publicEmail: testemail@email.com
website: ''
refreshDate: 2014-12-03T11:46:11.2830000
lastRefreshAttempt: 2014-12-03T11:46:53.4330000
createDate: 2014-07-25T11:05:55.3070000
modifyDate: 2014-11-12T08:45:20.5500000
autoRefresh: false
ListMarketplacesresponse:
title: ListMarketplacesresponse
required:
- name
- marketplaceId
- canRefresh
- supportsCustomMappings
- supportsCustomStatuses
- canConfirmShipments
type: object
properties:
name:
type: string
example: 3DCart
marketplaceId:
type: integer
format: int32
example: 23
canRefresh:
type: boolean
example: true
supportsCustomMappings:
type: boolean
example: true
supportsCustomStatuses:
type: boolean
example: false
canConfirmShipments:
type: boolean
example: true
example:
name: 3DCart
marketplaceId: 23
canRefresh: true
supportsCustomMappings: true
supportsCustomStatuses: false
canConfirmShipments: true
DeactivateStorerequest:
title: DeactivateStorerequest
required:
- storeId
type: object
properties:
storeId:
type: string
example:
storeId: 12345
DeactivateStoreresponse:
title: DeactivateStoreresponse
required:
- success
- message
type: object
properties:
success:
type: string
message:
type: string
example:
success: true
message: The requested store has been reactivated.
ReactivateStorerequest:
title: ReactivateStorerequest
required:
- storeId
type: object
properties:
storeId:
type: string
example:
storeId: 12345
ReactivateStoreresponse:
title: ReactivateStoreresponse
required:
- success
- message
type: object
properties:
success:
type: string
message:
type: string
example:
success: true
message: The requested store has been reactivated.
ListUsersresponse:
title: ListUsersresponse
required:
- userId
- userName
- name
type: object
properties:
userId:
type: string
userName:
type: string
name:
type: string
example:
userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa
userName: SS-user1
name: Shipping Employee 1
GetWarehouseresponse:
title: GetWarehouseresponse
required:
- warehouseId
- warehouseName
- originAddress
- returnAddress
- createDate
- isDefault
type: object
properties:
warehouseId:
type: integer
format: int32
warehouseName:
type: string
originAddress:
$ref: '#/components/schemas/OriginAddress'
returnAddress:
$ref: '#/components/schemas/ReturnAddress'
createDate:
type: string
isDefault:
type: boolean
example:
warehouseId: 12345
warehouseName: API Ship From Location
originAddress:
name: API Warehouse
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential: true
addressVerified:
returnAddress:
name: API Ship From Location
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential:
addressVerified:
createDate: 2015-07-02T08:38:31.4870000
isDefault: true
OriginAddress:
title: OriginAddress
required:
- name
- company
- street1
- city
- state
- postalCode
- country
- phone
- residential
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: boolean
addressVerified:
type: string
nullable: true
ReturnAddress:
title: ReturnAddress
required:
- name
- company
- street1
- city
- state
- postalCode
- country
- phone
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: string
nullable: true
addressVerified:
type: string
nullable: true
UpdateWarehouserequest:
title: UpdateWarehouserequest
required:
- warehouseId
- warehouseName
- originAddress
- returnAddress
- createDate
- isDefault
type: object
properties:
warehouseId:
type: integer
format: int32
warehouseName:
type: string
originAddress:
$ref: '#/components/schemas/OriginAddress'
returnAddress:
$ref: '#/components/schemas/ReturnAddress'
createDate:
type: string
isDefault:
type: boolean
example:
warehouseId: 12345
warehouseName: API Ship From Location
originAddress:
name: API Warehouse
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential: true
addressVerified:
returnAddress:
name: API Ship From Location
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential:
addressVerified:
createDate: 2015-07-02T08:38:31.4870000
isDefault: true
UpdateWarehouseresponse:
title: UpdateWarehouseresponse
required:
- warehouseId
- warehouseName
- originAddress
- returnAddress
- createDate
- isDefault
type: object
properties:
warehouseId:
type: integer
format: int32
warehouseName:
type: string
originAddress:
$ref: '#/components/schemas/OriginAddress'
returnAddress:
$ref: '#/components/schemas/ReturnAddress'
createDate:
type: string
isDefault:
type: boolean
example:
warehouseId: 12345
warehouseName: API Ship From Location
originAddress:
name: API Warehouse
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential: true
addressVerified:
returnAddress:
name: API Ship From Location
company: ShipStation
street1: 2815 Exposition Blvd
street2:
street3:
city: Austin
state: TX
postalCode: 78703
country: US
phone: 512-555-5555
residential:
addressVerified:
createDate: 2015-07-02T08:38:31.4870000
isDefault: true
DeleteWarehouseresponse:
title: DeleteWarehouseresponse
required:
- success
- message
type: object
properties:
success:
type: boolean
message:
type: string
example:
success: true
message: The requested warehouse has been deleted.
CreateWarehouserequest:
title: CreateWarehouserequest
required:
- warehouseName
- originAddress
- isDefault
type: object
properties:
warehouseName:
type: string
originAddress:
$ref: '#/components/schemas/OriginAddress3'
returnAddress:
type: string
nullable: true
isDefault:
type: boolean
example:
warehouseName: New Ship From Location
originAddress:
name: NM Warehouse
company: White Sands Co.
street1: 4704 Arabela Dr.
street2:
street3:
city: Las Cruces
state: NM
postalCode: 80012
country: US
phone: 512-111-2222
residential: true
returnAddress:
isDefault: false
OriginAddress3:
title: OriginAddress3
required:
- name
- company
- street1
- city
- state
- postalCode
- country
- phone
- residential
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
nullable: true
street3:
type: string
nullable: true
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: boolean
CreateWarehouseresponse:
title: CreateWarehouseresponse
required:
- warehouseId
- warehouseName
- originAddress
- returnAddress
- createDate
- isDefault
type: object
properties:
warehouseId:
type: integer
format: int32
warehouseName:
type: string
originAddress:
$ref: '#/components/schemas/OriginAddress4'
returnAddress:
$ref: '#/components/schemas/ReturnAddress3'
createDate:
type: string
isDefault:
type: boolean
example:
warehouseId: 17977
warehouseName: New Ship From Location
originAddress:
name: NM Warehouse
company: White Sands Co
street1: 4704 Arabela Dr.
street2: ''
street3: ''
city: Las Cruces
state: NM
postalCode: 88012
country: US
phone: 512-111-2222
residential: true
returnAddress:
name: NM Warehouse
company: White Sands Co
street1: 4704 Arabela Dr.
street2: ''
street3: ''
city: Las Cruces
state: NM
postalCode: 88012
country: US
phone: 512-111-2222
residential:
createDate: 2014-10-21T08:11:43.8800000
isDefault: false
OriginAddress4:
title: OriginAddress4
required:
- name
- company
- street1
- street2
- street3
- city
- state
- postalCode
- country
- phone
- residential
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
street3:
type: string
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: boolean
example:
name: Spring warehouse
company: ''
street1: '123 S SPRING RD '
street2: ''
street3: ''
city: Elmurst
state: IL
postalCode: 60126
country: US
phone: 5121112222
residential: false
ReturnAddress3:
title: ReturnAddress3
required:
- name
- company
- street1
- street2
- street3
- city
- state
- postalCode
- country
- phone
type: object
properties:
name:
type: string
company:
type: string
street1:
type: string
street2:
type: string
street3:
type: string
city:
type: string
state:
type: string
postalCode:
type: string
country:
type: string
phone:
type: string
residential:
type: string
nullable: true
example:
name: Chicago House
company: ''
street1: '123 S SPRING RD '
street2: ''
street3: ''
city: Elmurst
state: IL
postalCode: 60126
country: US
phone: 5121112222
residential:
ListWarehousesresponse:
title: ListWarehousesresponse
required:
- warehouseId
- warehouseName
- originAddress
- returnAddress
- createDate
- isDefault
type: object
properties:
warehouseId:
type: integer
format: int32
example: 17977
warehouseName:
type: string
example: Main warehouse
originAddress:
$ref: '#/components/schemas/OriginAddress4'
returnAddress:
$ref: '#/components/schemas/ReturnAddress3'
createDate:
type: string
example: 10/21/2014 8:11:43 AM
isDefault:
type: boolean
example: true
example:
warehouseId: 17977
warehouseName: Main warehouse
originAddress:
name: Spring warehouse
company: ''
street1: '123 S SPRING RD '
street2: ''
street3: ''
city: Elmurst
state: IL
postalCode: 60126
country: US
phone: 5121112222
residential: false
returnAddress:
name: Chicago House
company: ''
street1: '123 S SPRING RD '
street2: ''
street3: ''
city: Elmurst
state: IL
postalCode: 60126
country: US
phone: 5121112222
residential:
createDate: 2014-10-21T08:11:43.8800000
isDefault: true
ListWebhooksresponse:
title: ListWebhooksresponse
required:
- webhooks
type: object
properties:
webhooks:
type: array
items:
$ref: '#/components/schemas/Webhook'
description: ''
example:
webhooks:
- IsLabelAPIHook: false
WebHookID: 123
SellerID: 100000
StoreID: 12345
HookType: ITEM_ORDER_NOTIFY
MessageFormat: Json
Url: http://example.endpoint/orders
Name: My Order Webhook
BulkCopyBatchID:
BulkCopyRecordID:
Active: true
WebhookLogs: []
Seller:
Store:
- IsLabelAPIHook: false
WebHookID: 456
SellerID: 100000
StoreID: 98765
HookType: SHIP_NOTIFY
MessageFormat: Json
Url: https://example.endpoint/shipment
Name: My Shipment Webhook
BulkCopyBatchID:
BulkCopyRecordID:
Active: true
WebhookLogs: []
Seller:
Store:
Webhook:
title: Webhook
required:
- IsLabelAPIHook
- WebHookID
- SellerID
- StoreID
- HookType
- MessageFormat
- Url
- Name
- Active
- WebhookLogs
type: object
properties:
IsLabelAPIHook:
type: boolean
example: false
WebHookID:
type: integer
format: int32
example: 123
SellerID:
type: integer
format: int32
example: 100000
StoreID:
type: integer
format: int32
example: 12345
HookType:
type: string
example: ITEM_ORDER_NOTIFY
MessageFormat:
type: string
example: Json
Url:
type: string
example: http://example.endpoint/orders
Name:
type: string
example: My Order Webhook
BulkCopyBatchID:
type: string
nullable: true
BulkCopyRecordID:
type: string
nullable: true
Active:
type: boolean
example: true
WebhookLogs:
type: array
items:
type: string
description: ''
Seller:
type: string
nullable: true
Store:
type: string
nullable: true
SubscribetoWebhookrequest:
title: SubscribetoWebhookrequest
required:
- target_url
- event
- friendly_name
type: object
properties:
target_url:
type: string
event:
type: string
store_id:
type: string
nullable: true
friendly_name:
type: string
example:
target_url: http://someexamplewebhookurl.com/neworder
event: ORDER_NOTIFY
store_id:
friendly_name: My Webhook
SubscribetoWebhookresponse:
title: SubscribetoWebhookresponse
required:
- id
type: object
properties:
id:
type: integer
format: int32
example:
id: 123456
securitySchemes:
httpBasic:
type: http
scheme: basic
security:
- httpBasic: []
tags:
- name: Accounts
description: ''
- name: Carriers
description: ''
- name: Customers
description: ''
- name: Fulfillments
description: ''
- name: Orders
description: ''
- name: Products
description: ''
- name: Shipments
description: ''
- name: Stores
description: ''
- name: Users
description: ''
- name: Warehouses
description: ''
- name: Webhooks
description: ''
@michael-land
Copy link

Hi @stchr, can you please share where did you find their schema definitions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment