Skip to content

Instantly share code, notes, and snippets.

@stchr

stchr/shipstation-Swagger20.json

Created February 27, 2019 14:43
Show Gist options
  • Save stchr/1521faa7bb32f72839e86123eb4ae6d3 to your computer and use it in GitHub Desktop.
Save stchr/1521faa7bb32f72839e86123eb4ae6d3 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
shipstation-Swagger20.json
{
"swagger": "2.0",
"info": {
"version": "1.0",
"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": {}
},
"host": "ssapi.shipstation.com",
"basePath": "/",
"securityDefinitions": {
"auth": {
"type": "basic"
}
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/accounts/registeraccount": {
"post": {
"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.",
"summary": "Register Account",
"tags": [
"Accounts"
],
"operationId": "AccountsRegisteraccountPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RegisterAccountrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/RegisterAccountresponse"
},
"examples": {
"application/json": {
"message": "ShipStation account created.",
"sellerId": 123456,
"success": true,
"apiKey": "abcdt9845hjmgfklj3498gkljdkuyekl",
"apiSecret": "1234iou983lkj8mnxgfwu509hkhdy7u3"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/accounts/listtags": {
"get": {
"description": "Lists all tags defined for this account.",
"summary": "List Tags",
"tags": [
"Accounts"
],
"operationId": "AccountsListtagsGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListTagsresponse"
}
},
"examples": {
"application/json": [
{
"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"
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/carriers": {
"get": {
"description": "Lists all shipping providers connected to this account.",
"summary": "List Carriers",
"tags": [
"Carriers"
],
"operationId": "CarriersGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListCarriersresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/carriers/getcarrier?carrierCode={carrierCode}": {
"get": {
"description": "Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.",
"summary": "Get Carrier",
"tags": [
"Carriers"
],
"operationId": "CarriersGetcarrierByCarrierCodeGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "carrierCode",
"in": "path",
"required": true,
"type": "string",
"description": "The code for the carrier account to retrieve."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetCarrierresponse"
},
"examples": {
"application/json": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": null,
"shippingProviderId": 12345,
"primary": true
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/carriers/addfunds": {
"post": {
"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.",
"summary": "Add Funds",
"tags": [
"Carriers"
],
"operationId": "CarriersAddfundsPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddFundsrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/AddFundsresponse"
},
"examples": {
"application/json": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.14
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/carriers/listpackages?carrierCode={carrierCode}": {
"get": {
"description": "Retrieves a list of packages for the specified carrier",
"summary": "List Packages",
"tags": [
"Carriers"
],
"operationId": "CarriersListpackagesByCarrierCodeGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "carrierCode",
"in": "path",
"required": true,
"type": "string",
"description": "The carrier's code"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListPackagesresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/carriers/listservices?carrierCode={carrierCode}": {
"get": {
"description": "Retrieves the list of available shipping services provided by the specified carrier",
"summary": "List Services",
"tags": [
"Carriers"
],
"operationId": "CarriersListservicesByCarrierCodeGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "carrierCode",
"in": "path",
"required": true,
"type": "string",
"description": "The carrier's code"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListServicesresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/customers/{customerId}": {
"get": {
"description": "",
"summary": "Get Customer",
"tags": [
"Customers"
],
"operationId": "CustomersByCustomerIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "The system generated identifier for the Customer."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetCustomerresponse"
},
"examples": {
"application/json": {
"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"
}
]
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/customers?stateCode={stateCode}&countryCode={countryCode}&tagId={tagId}&marketplaceId={marketplaceId}&sortBy={sortBy}&sortDir={sortDir}&page={page}&pageSize={pageSize}": {
"get": {
"description": "Obtains a list of customers that match the specified criteria.",
"summary": "List Customers",
"tags": [
"Customers"
],
"operationId": "CustomersTagIdTagIdMarketplaceIdMarketplaceIdSortBySortBySortDirSortDirPagePagePageSizePageSizeByStateCodeAndCountryCodeGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "stateCode",
"in": "path",
"required": true,
"type": "string",
"description": "Returns customers that reside in the specified stateCode."
},
{
"name": "countryCode",
"in": "path",
"required": true,
"type": "string",
"description": "Returns customers that reside in the specified countryCode."
},
{
"name": "marketplaceId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns customers that purchased items from the specified marketplaceId."
},
{
"name": "tagId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns customers that have been tagged with the specified tagId."
},
{
"name": "sortBy",
"in": "path",
"required": true,
"enum": [
"Name",
"ModifyDate",
"CreateDate"
],
"type": "string",
"description": "Sorts the order of the response based off the specified value."
},
{
"name": "sortDir",
"in": "path",
"required": true,
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "Sets the direction of the sort order."
},
{
"name": "page",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Page number."
},
{
"name": "pageSize",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Requested page size. Max value is 500."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListCustomersresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/fulfillments": {
"get": {
"description": "",
"summary": "List Fulfillments w/o parameters",
"tags": [
"Fulfillments"
],
"operationId": "FulfillmentsGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListFulfillmentsw~1oparametersresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/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": {
"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```",
"summary": "List Fulfillments with parameters",
"tags": [
"Fulfillments"
],
"operationId": "FulfillmentsOrderNumberOrderNumberTrackingNumberTrackingNumberRecipientNameRecipientNameCreateDateStartCreateDateStartCreateDateEndCreateDateEndShipDateStartShipDateStartShipDateEndShipDateEndSortBySortBySortDirSortDirPagePagePageSizePageSizeByFulfillmentIdAndOrderIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "fulfillmentId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns the fulfillment with the specified fulfillment ID."
},
{
"name": "orderId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns fulfillments whose orders have the specified order ID."
},
{
"name": "orderNumber",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments whose orders have the specified order number."
},
{
"name": "trackingNumber",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments with the specified tracking number."
},
{
"name": "recipientName",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments shipped to the specified recipient name."
},
{
"name": "createDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments created on or after the specified ``createDate``"
},
{
"name": "createDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments created on or before the specified ``createDate``"
},
{
"name": "shipDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments with the ``shipDate`` on or after the specified date"
},
{
"name": "shipDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns fulfillments with the ``shipDate`` on or before the specified date"
},
{
"name": "sortBy",
"in": "path",
"required": true,
"enum": [
"ShipDate",
"CreateDate"
],
"type": "string",
"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``."
},
{
"name": "sortDir",
"in": "path",
"required": true,
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "Sets the direction of the sort order."
},
{
"name": "page",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "page number."
},
{
"name": "pageSize",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "page size."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListFulfillmentswithparametersresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/{orderId}": {
"get": {
"description": "Retrieves a single order from the database.",
"summary": "Get Order",
"tags": [
"Orders"
],
"operationId": "OrdersByOrderIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "The system generated identifier for the order."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetOrderresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
},
"delete": {
"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``",
"summary": "Delete Order",
"tags": [
"Orders"
],
"operationId": "OrdersByOrderIdDelete",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "The system generated identifier for the order."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/DeleteOrderresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "The requested order has been deleted."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/addtag": {
"post": {
"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.",
"summary": "Add Tag to Order",
"tags": [
"Orders"
],
"operationId": "OrdersAddtagPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddTagtoOrderrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/AddTagtoOrderresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "Tag added successfully."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/assignuser": {
"post": {
"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.",
"summary": "Assign User to Order",
"tags": [
"Orders"
],
"operationId": "OrdersAssignuserPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AssignUsertoOrderrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/AssignUsertoOrderresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "User assigned successfully."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/createlabelfororder": {
"post": {
"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.",
"summary": "Create Label for Order",
"tags": [
"Orders"
],
"operationId": "OrdersCreatelabelfororderPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateLabelforOrderrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/CreateLabelforOrderresponse"
},
"examples": {
"application/json": {
"shipmentId": 72513480,
"shipmentCost": 7.3,
"insuranceCost": 0,
"trackingNumber": "248201115029520",
"labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEJDBV0jCz0LBV1jY0M9I4XkXAX9iDRDBZd8hUAuAEdGC7cKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveFswIDAgMjg4IDQzMl0vUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vQ29udGVudHMgMiAwIFIvUGFyZW50....",
"formData": null
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/createorder": {
"post": {
"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.",
"summary": "Create/Update Order",
"tags": [
"Orders"
],
"operationId": "OrdersCreateorderPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/Create~1UpdateOrderrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/Create~1UpdateOrderresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/createorders": {
"post": {
"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)",
"summary": "Create/Update Multiple Orders",
"tags": [
"Orders"
],
"operationId": "OrdersCreateordersPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Create~1UpdateMultipleOrdersrequest"
}
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/Create~1UpdateMultipleOrdersresponse"
},
"examples": {
"application/json": {
"hasErrors": false,
"results": [
{
"orderId": 58345234,
"orderNumber": "TEST-ORDER-API-DOCS",
"orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"success": true,
"errorMessage": null
}
]
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/holduntil": {
"post": {
"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``.",
"summary": "Hold Order Until",
"tags": [
"Orders"
],
"operationId": "OrdersHolduntilPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/HoldOrderUntilrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/HoldOrderUntilresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "Order held successfully."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders": {
"get": {
"description": "",
"summary": "List Orders w/o parameters",
"tags": [
"Orders"
],
"operationId": "OrdersGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListOrdersw~1oparametersresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/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": {
"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```",
"summary": "List Orders with parameters",
"tags": [
"Orders"
],
"operationId": "OrdersCreateDateStartCreateDateStartCreateDateEndCreateDateEndModifyDateStartModifyDateStartModifyDateEndModifyDateEndOrderDateStartOrderDateStartOrderDateEndOrderDateEndOrderNumberOrderNumberOrderStatusOrderStatusPaymentDateStartPaymentDateStartPaymentDateEndPaymentDateEndStoreIdStoreIdSortBySortBySortDirSortDirPagePagePageSizePageSizeByCustomerNameAndItemKeywordGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "customerName",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that match the specified name."
},
{
"name": "itemKeyword",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options"
},
{
"name": "createDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that were created in ShipStation after the specified date"
},
{
"name": "createDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that were created in ShipStation before the specified date"
},
{
"name": "modifyDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that were modified after the specified date"
},
{
"name": "modifyDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that were modified before the specified date"
},
{
"name": "orderDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders greater than the specified date"
},
{
"name": "orderDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders less than or equal to the specified date"
},
{
"name": "orderNumber",
"in": "path",
"required": true,
"type": "string",
"description": "Filter by order number, performs a \"starts with\" search."
},
{
"name": "orderStatus",
"in": "path",
"required": true,
"enum": [
"awaiting_payment",
"awaiting_shipment",
"pending_fulfillment",
"shipped",
"on_hold",
"cancelled"
],
"type": "string",
"description": "Filter by order status. If left empty, orders of all statuses are returned."
},
{
"name": "paymentDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that were paid after the specified date"
},
{
"name": "paymentDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns orders that were paid before the specified date"
},
{
"name": "storeId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Filters orders to a single store. Call List Stores to obtain a list of store Ids."
},
{
"name": "sortBy",
"in": "path",
"required": true,
"enum": [
"OrderDate",
"ModifyDate",
"CreateDate"
],
"type": "string",
"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``."
},
{
"name": "sortDir",
"in": "path",
"required": true,
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "Sets the direction of the sort order."
},
{
"name": "page",
"in": "path",
"required": true,
"type": "string",
"description": "Page number"
},
{
"name": "pageSize",
"in": "path",
"required": true,
"type": "string",
"description": "Requested page size. Max value is 500."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListOrderswithparametersresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/listbytag?orderStatus={orderStatus}&tagId={tagId}&page={page}&pageSize={pageSize}": {
"get": {
"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```",
"summary": "List Orders by Tag",
"tags": [
"Orders"
],
"operationId": "OrdersListbytagPagePagePageSizePageSizeByOrderStatusAndTagIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "orderStatus",
"in": "path",
"required": true,
"enum": [
"awaiting_payment",
"awaiting_shipment",
"pending_fulfillment",
"shipped",
"on_hold",
"cancelled"
],
"type": "string",
"description": "The order's status."
},
{
"name": "tagId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "ID of the tag. Call Accounts/ListTags to obtain a list of tags for this account."
},
{
"name": "page",
"in": "path",
"required": true,
"type": "string",
"description": "Page number"
},
{
"name": "pageSize",
"in": "path",
"required": true,
"type": "string",
"description": "Requested page size. Max value is 500."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListOrdersbyTagresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/markasshipped": {
"post": {
"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",
"summary": "Mark an Order as Shipped",
"tags": [
"Orders"
],
"operationId": "OrdersMarkasshippedPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/MarkanOrderasShippedrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/MarkanOrderasShippedresponse"
},
"examples": {
"application/json": {
"orderId": 123456789,
"orderNumber": "ABC123"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/removetag": {
"post": {
"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.",
"summary": "Remove Tag from Order",
"tags": [
"Orders"
],
"operationId": "OrdersRemovetagPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RemoveTagfromOrderrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/RemoveTagfromOrderresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "Tag removed successfully."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/restorefromhold": {
"post": {
"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``.",
"summary": "Restore Order from On Hold",
"tags": [
"Orders"
],
"operationId": "OrdersRestorefromholdPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RestoreOrderfromOnHoldrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/RestoreOrderfromOnHoldresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "The requested order has been restored"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/orders/unassignuser": {
"post": {
"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.",
"summary": "Unassign User from Order",
"tags": [
"Orders"
],
"operationId": "OrdersUnassignuserPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UnassignUserfromOrderrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/UnassignUserfromOrderresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "User unassigned successfully."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/products/{productId}": {
"get": {
"description": "",
"summary": "Get Product",
"tags": [
"Products"
],
"operationId": "ProductsByProductIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "productId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "The system generated identifier for the Product."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetProductresponse"
},
"examples": {
"application/json": {
"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"
}
]
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
},
"put": {
"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.",
"summary": "Update Product",
"tags": [
"Products"
],
"operationId": "ProductsByProductIdPut",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "productId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "The system generated identifier for the Product."
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProductrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProductresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "The requested product has been updated"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/products": {
"get": {
"description": "",
"summary": "List Products w/o parameters",
"tags": [
"Products"
],
"operationId": "ProductsGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListProductsw~1oparametersresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/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": {
"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```",
"summary": "List Products with parameters",
"tags": [
"Products"
],
"operationId": "ProductsProductCategoryIdProductCategoryIdProductTypeIdProductTypeIdTagIdTagIdStartDateStartDateEndDateEndDateShowInactiveShowInactiveSortBySortBySortDirSortDirPagePagePageSizePageSizeBySkuAndNameGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "sku",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that match the specified SKU."
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that match the specified product name."
},
{
"name": "productCategoryId",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that match the specified productCategoryId."
},
{
"name": "productTypeId",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that match the specified productTypeId."
},
{
"name": "tagId",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that match the specified tagId."
},
{
"name": "startDate",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that were created after the specified date."
},
{
"name": "endDate",
"in": "path",
"required": true,
"type": "string",
"description": "Returns products that were created before the specified date."
},
{
"name": "sortBy",
"in": "path",
"required": true,
"enum": [
"SKU",
"ModifyDate",
"CreateDate"
],
"type": "string",
"description": "Sorts the order of the response based off the specified value."
},
{
"name": "sortDir",
"in": "path",
"required": true,
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "Sets the direction of the sort order."
},
{
"name": "page",
"in": "path",
"required": true,
"type": "string",
"description": "Page number."
},
{
"name": "pageSize",
"in": "path",
"required": true,
"type": "string",
"description": "Requested page size. Max value is 500."
},
{
"name": "showInactive",
"in": "path",
"required": true,
"type": "string",
"description": "Specifies whether the list should include inactive products."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListProductswithparametersresponse"
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/shipments": {
"get": {
"description": "",
"summary": "List Shipments w/o parameters",
"tags": [
"Shipments"
],
"operationId": "ShipmentsGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListShipmentsw~1oparametersresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/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": {
"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```",
"summary": "List Shipments with parameters",
"tags": [
"Shipments"
],
"operationId": "ShipmentsOrderNumberOrderNumberOrderIdOrderIdCarrierCodeCarrierCodeServiceCodeServiceCodeTrackingNumberTrackingNumberCreateDateStartCreateDateStartCreateDateEndCreateDateEndShipDateStartShipDateStartShipDateEndShipDateEndVoidDateStartVoidDateStartVoidDateEndVoidDateEndStoreIdStoreIdIncludeShipmentItemsIncludeShipmentItemsSortBySortBySortDirSortDirPagePagePageSizePageSizeByRecipientNameAndRecipientCountryCodeGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "recipientName",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments shipped to the specified recipient name."
},
{
"name": "recipientCountryCode",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments shipped to the specified country code."
},
{
"name": "orderNumber",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments whose orders have the specified order number."
},
{
"name": "orderId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns shipments whose orders have the specified order ID."
},
{
"name": "carrierCode",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments shipped with the specified carrier."
},
{
"name": "serviceCode",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments shipped with the specified shipping service."
},
{
"name": "trackingNumber",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments with the specified tracking number."
},
{
"name": "createDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments created on or after the specified ``createDate``"
},
{
"name": "createDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments created on or before the specified ``createDate``"
},
{
"name": "shipDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments with the ``shipDate`` on or after the specified date"
},
{
"name": "shipDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments with the ``shipDate`` on or before the specified date"
},
{
"name": "voidDateStart",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments voided on or after the specified date"
},
{
"name": "voidDateEnd",
"in": "path",
"required": true,
"type": "string",
"description": "Returns shipments voided on or before the specified date"
},
{
"name": "storeId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns shipments whose orders belong to the specified store ID."
},
{
"name": "includeShipmentItems",
"in": "path",
"required": true,
"type": "boolean",
"description": "Specifies whether to include shipment items with results Default value: false."
},
{
"name": "sortBy",
"in": "path",
"required": true,
"enum": [
"ShipDate",
"CreateDate"
],
"type": "string",
"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``."
},
{
"name": "sortDir",
"in": "path",
"required": true,
"enum": [
"ASC",
"DESC"
],
"type": "string",
"description": "Sets the direction of the sort order."
},
{
"name": "page",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "page number."
},
{
"name": "pageSize",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "page size."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListShipmentswithparametersresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/shipments/createlabel": {
"post": {
"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.",
"summary": "Create Shipment Label",
"tags": [
"Shipments"
],
"operationId": "ShipmentsCreatelabelPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateShipmentLabelrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/CreateShipmentLabelresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/shipments/getrates": {
"post": {
"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",
"summary": "Get Rates",
"tags": [
"Shipments"
],
"operationId": "ShipmentsGetratesPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/GetRatesrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/GetRatesresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/shipments/voidlabel": {
"post": {
"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.",
"summary": "Void Label",
"tags": [
"Shipments"
],
"operationId": "ShipmentsVoidlabelPost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/VoidLabelrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/VoidLabelresponse"
},
"examples": {
"application/json": {
"approved": true,
"message": "Label voided successfully"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores/{storeId}": {
"get": {
"description": "",
"summary": "Get Store",
"tags": [
"Stores"
],
"operationId": "StoresByStoreIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "A unique ID generated by ShipStation and assigned to each store."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetStoreresponse"
},
"examples": {
"application/json": {
"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"
}
]
}
},
"headers": {
"Authorization": {
"type": "string",
"default": "< Enter your Basic Authorization string here >"
}
}
}
},
"security": [
{
"auth": []
}
]
},
"put": {
"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.",
"summary": "Update Store",
"tags": [
"Stores"
],
"operationId": "StoresByStoreIdPut",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "A unique ID generated by ShipStation and assigned to each store."
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateStorerequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/UpdateStoreresponse"
},
"examples": {
"application/json": {
"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"
}
]
}
},
"headers": {
"Authorization": {
"type": "string",
"default": "< Enter your Basic Authorization string here >"
}
}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores/getrefreshstatus?storeId={storeId}": {
"get": {
"description": "Retrieves the refresh status of a given store.",
"summary": "Get Store Refresh Status",
"tags": [
"Stores"
],
"operationId": "StoresGetrefreshstatusByStoreIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Specifies the store whose status will be retrieved."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetStoreRefreshStatusresponse"
},
"examples": {
"application/json": {
"storeId": 12345,
"refreshStatusId": 2,
"refreshStatus": "Updating orders",
"lastRefreshAttempt": "8-13-2014",
"refreshDate": "8-13-2014"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores/refreshstore?storeId={storeId}&refreshDate={refreshDate}": {
"post": {
"description": "Initiates a store refresh.",
"summary": "Refresh Store",
"tags": [
"Stores"
],
"operationId": "StoresRefreshstoreByStoreIdAndRefreshDatePost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RefreshStorerequest"
}
},
{
"name": "storeId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"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."
},
{
"name": "refreshDate",
"in": "path",
"required": true,
"type": "string",
"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."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/RefreshStoreresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "A store refresh has been initiated for Store ID 12345"
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores?showInactive={showInactive}&marketplaceId={marketplaceId}": {
"get": {
"description": "Retrieve the list of installed stores on the account.",
"summary": "List Stores",
"tags": [
"Stores"
],
"operationId": "StoresByShowInactiveAndMarketplaceIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "showInactive",
"in": "path",
"required": true,
"type": "boolean",
"description": "Determines whether inactive stores will be returned in the list of stores."
},
{
"name": "marketplaceId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "Returns stores of this marketplace type."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListStoresresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores/marketplaces": {
"get": {
"description": "Lists the marketplaces that can be integrated with ShipStation.",
"summary": "List Marketplaces",
"tags": [
"Stores"
],
"operationId": "StoresMarketplacesGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListMarketplacesresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores/deactivate": {
"post": {
"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.",
"summary": "Deactivate Store",
"tags": [
"Stores"
],
"operationId": "StoresDeactivatePost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DeactivateStorerequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/DeactivateStoreresponse"
},
"examples": {
"application/json": {
"success": "true",
"message": "The requested store has been reactivated."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/stores/reactivate": {
"post": {
"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.",
"summary": "Reactivate Store",
"tags": [
"Stores"
],
"operationId": "StoresReactivatePost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ReactivateStorerequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ReactivateStoreresponse"
},
"examples": {
"application/json": {
"success": "true",
"message": "The requested store has been reactivated."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/users?showInactive={showInactive}": {
"get": {
"description": "",
"summary": "List Users",
"tags": [
"Users"
],
"operationId": "UsersByShowInactiveGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "showInactive",
"in": "path",
"required": true,
"type": "boolean",
"description": "Determines whether inactive users will be returned in the response."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListUsersresponse"
},
"examples": {
"application/json": {
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"userName": "SS-user1",
"name": "Shipping Employee 1"
}
},
"headers": {
"Authorization": {
"type": "string",
"default": "< Enter your Basic Authorization string here >"
}
}
}
},
"security": [
{
"auth": []
}
]
}
},
"/warehouses/{warehouseId}": {
"get": {
"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.",
"summary": "Get Warehouse",
"tags": [
"Warehouses"
],
"operationId": "WarehousesByWarehouseIdGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "warehouseId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse)."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/GetWarehouseresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {
"Authorization": {
"type": "string",
"default": "< Enter your Basic Authorization string here >"
}
}
}
},
"security": [
{
"auth": []
}
]
},
"put": {
"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\".",
"summary": "Update Warehouse",
"tags": [
"Warehouses"
],
"operationId": "WarehousesByWarehouseIdPut",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateWarehouserequest"
}
},
{
"name": "warehouseId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse)."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/UpdateWarehouseresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {
"Authorization": {
"type": "string",
"default": "< Enter your Basic Authorization string here >"
}
}
}
},
"security": [
{
"auth": []
}
]
},
"delete": {
"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",
"summary": "Delete Warehouse",
"tags": [
"Warehouses"
],
"operationId": "WarehousesByWarehouseIdDelete",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "warehouseId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse)."
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/DeleteWarehouseresponse"
},
"examples": {
"application/json": {
"success": true,
"message": "The requested warehouse has been deleted."
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/warehouses/createwarehouse": {
"post": {
"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.",
"summary": "Create Warehouse",
"tags": [
"Warehouses"
],
"operationId": "WarehousesCreatewarehousePost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateWarehouserequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/CreateWarehouseresponse"
},
"examples": {
"application/json": {
"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
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/warehouses": {
"get": {
"description": "Retrieves a list of your Ship From Locations (formerly known as warehouses).",
"summary": "List Warehouses",
"tags": [
"Warehouses"
],
"operationId": "WarehousesGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ListWarehousesresponse"
}
},
"examples": {
"application/json": [
{
"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
}
]
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/webhooks": {
"get": {
"description": "Retrieves a list of registered webhooks for the account",
"summary": "List Webhooks",
"tags": [
"Webhooks"
],
"operationId": "WebhooksGet",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ListWebhooksresponse"
},
"examples": {
"application/json": {
"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
}
]
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/webhooks/subscribe": {
"post": {
"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",
"summary": "Subscribe to Webhook",
"tags": [
"Webhooks"
],
"operationId": "WebhooksSubscribePost",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/SubscribetoWebhookrequest"
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/SubscribetoWebhookresponse"
},
"examples": {
"application/json": {
"id": 123456
}
},
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
},
"/webhooks/{webhookId}": {
"delete": {
"description": "Unsubscribes from a certain webhook.",
"summary": "Unsubscribe to Webhook",
"tags": [
"Webhooks"
],
"operationId": "WebhooksByWebhookIdDelete",
"deprecated": false,
"produces": [
"application/json"
],
"parameters": [
{
"name": "webhookId",
"in": "path",
"required": true,
"type": "number",
"format": "double",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"description": "A unique ID generated by ShipStation and assigned to each webhook."
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"security": [
{
"auth": []
}
]
}
}
},
"definitions": {
"RegisterAccountrequest": {
"title": "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"
},
"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"
}
},
"required": [
"firstName",
"lastName",
"email",
"password",
"shippingOriginCountryCode",
"companyName",
"addr1",
"addr2",
"city",
"state",
"zip",
"countryCode",
"phone"
]
},
"RegisterAccountresponse": {
"title": "RegisterAccountresponse",
"example": {
"message": "ShipStation account created.",
"sellerId": 123456,
"success": true,
"apiKey": "abcdt9845hjmgfklj3498gkljdkuyekl",
"apiSecret": "1234iou983lkj8mnxgfwu509hkhdy7u3"
},
"type": "object",
"properties": {
"message": {
"type": "string"
},
"sellerId": {
"type": "integer",
"format": "int32"
},
"success": {
"type": "boolean"
},
"apiKey": {
"type": "string"
},
"apiSecret": {
"type": "string"
}
},
"required": [
"message",
"sellerId",
"success",
"apiKey",
"apiSecret"
]
},
"ListTagsresponse": {
"title": "ListTagsresponse",
"example": {
"tagId": 8362,
"name": "Backorder",
"color": "#800080"
},
"type": "object",
"properties": {
"tagId": {
"example": 8362,
"type": "integer",
"format": "int32"
},
"name": {
"example": "Backorder",
"type": "string"
},
"color": {
"example": "#800080",
"type": "string"
}
},
"required": [
"tagId",
"name",
"color"
]
},
"ListCarriersresponse": {
"title": "ListCarriersresponse",
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": "null",
"shippingProviderId": 12345,
"primary": true
},
"type": "object",
"properties": {
"name": {
"example": "Stamps.com",
"type": "string"
},
"code": {
"example": "stamps_com",
"type": "string"
},
"accountNumber": {
"example": "SS123",
"type": "string"
},
"requiresFundedAccount": {
"example": true,
"type": "boolean"
},
"balance": {
"example": 24.27,
"type": "number",
"format": "double"
},
"nickname": {
"type": "string"
},
"shippingProviderId": {
"example": 12345,
"type": "integer",
"format": "int32"
},
"primary": {
"example": true,
"type": "boolean"
}
},
"required": [
"name",
"code",
"accountNumber",
"requiresFundedAccount",
"balance",
"shippingProviderId",
"primary"
]
},
"GetCarrierresponse": {
"title": "GetCarrierresponse",
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.27,
"nickname": null,
"shippingProviderId": 12345,
"primary": true
},
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"requiresFundedAccount": {
"type": "boolean"
},
"balance": {
"type": "number",
"format": "double"
},
"nickname": {
"type": "string"
},
"shippingProviderId": {
"type": "integer",
"format": "int32"
},
"primary": {
"type": "boolean"
}
},
"required": [
"name",
"code",
"accountNumber",
"requiresFundedAccount",
"balance",
"shippingProviderId",
"primary"
]
},
"AddFundsrequest": {
"title": "AddFundsrequest",
"example": {
"carrierCode": "fedex",
"amount": 20.0
},
"type": "object",
"properties": {
"carrierCode": {
"type": "string"
},
"amount": {
"type": "number",
"format": "double"
}
},
"required": [
"carrierCode",
"amount"
]
},
"AddFundsresponse": {
"title": "AddFundsresponse",
"example": {
"name": "Stamps.com",
"code": "stamps_com",
"accountNumber": "SS123",
"requiresFundedAccount": true,
"balance": 24.14
},
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"requiresFundedAccount": {
"type": "boolean"
},
"balance": {
"type": "number",
"format": "double"
}
},
"required": [
"name",
"code",
"accountNumber",
"requiresFundedAccount",
"balance"
]
},
"ListPackagesresponse": {
"title": "ListPackagesresponse",
"example": {
"carrierCode": "express_1",
"code": "cubic",
"name": "Cubic",
"domestic": true,
"international": false
},
"type": "object",
"properties": {
"carrierCode": {
"example": "express_1",
"type": "string"
},
"code": {
"example": "cubic",
"type": "string"
},
"name": {
"example": "Cubic",
"type": "string"
},
"domestic": {
"example": true,
"type": "boolean"
},
"international": {
"example": false,
"type": "boolean"
}
},
"required": [
"carrierCode",
"code",
"name",
"domestic",
"international"
]
},
"ListServicesresponse": {
"title": "ListServicesresponse",
"example": {
"carrierCode": "fedex",
"code": "fedex_ground",
"name": "FedEx Ground®",
"domestic": true,
"international": false
},
"type": "object",
"properties": {
"carrierCode": {
"example": "fedex",
"type": "string"
},
"code": {
"example": "fedex_ground",
"type": "string"
},
"name": {
"example": "FedEx Ground®",
"type": "string"
},
"domestic": {
"example": true,
"type": "boolean"
},
"international": {
"example": false,
"type": "boolean"
}
},
"required": [
"carrierCode",
"code",
"name",
"domestic",
"international"
]
},
"GetCustomerresponse": {
"title": "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"
}
]
},
"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": "#/definitions/MarketplaceUsername"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"required": [
"customerId",
"createDate",
"modifyDate",
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"countryCode",
"phone",
"email",
"addressVerified",
"marketplaceUsernames",
"tags"
]
},
"MarketplaceUsername": {
"title": "MarketplaceUsername",
"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"
},
"type": "object",
"properties": {
"customerUserId": {
"example": 67195020,
"type": "integer",
"format": "int32"
},
"customerId": {
"example": 12345678,
"type": "integer",
"format": "int32"
},
"createDate": {
"example": "4/27/2015 12:35:03 PM",
"type": "string"
},
"modifyDate": {
"example": "5/14/2015 8:16:15 AM",
"type": "string"
},
"marketplaceId": {
"example": 0,
"type": "integer",
"format": "int32"
},
"marketplace": {
"example": "ShipStation",
"type": "string"
},
"username": {
"example": "camtheman@gmail.com",
"type": "string"
}
},
"required": [
"customerUserId",
"customerId",
"createDate",
"modifyDate",
"marketplaceId",
"marketplace",
"username"
]
},
"Tag": {
"title": "Tag",
"example": {
"tagId": 1234,
"name": "Expedited"
},
"type": "object",
"properties": {
"tagId": {
"example": 1234,
"type": "integer",
"format": "int32"
},
"name": {
"example": "Expedited",
"type": "string"
}
},
"required": [
"tagId",
"name"
]
},
"sortBy": {
"title": "sortBy",
"example": "Name",
"type": "string",
"enum": [
"Name",
"ModifyDate",
"CreateDate"
]
},
"sortDir": {
"title": "sortDir",
"example": "ASC",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"ListCustomersresponse": {
"title": "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
},
"type": "object",
"properties": {
"customers": {
"type": "array",
"items": {
"$ref": "#/definitions/Customer"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"customers",
"total",
"page",
"pages"
]
},
"Customer": {
"title": "Customer",
"type": "object",
"properties": {
"customerId": {
"example": 12345678,
"type": "integer",
"format": "int32"
},
"createDate": {
"example": "11/18/2014 10:33:01 AM",
"type": "string"
},
"modifyDate": {
"example": "11/18/2014 10:33:01 AM",
"type": "string"
},
"name": {
"example": "Cam Newton",
"type": "string"
},
"company": {
"example": "Test Company",
"type": "string"
},
"street1": {
"example": "123 War Eagle Lane",
"type": "string"
},
"street2": {
"type": "string"
},
"city": {
"example": "Auburn",
"type": "string"
},
"state": {
"example": "AL",
"type": "string"
},
"postalCode": {
"example": "36830",
"type": "string"
},
"countryCode": {
"example": "US",
"type": "string"
},
"phone": {
"example": "555-555-5555",
"type": "string"
},
"email": {
"example": "supermancam@example.com",
"type": "string"
},
"addressVerified": {
"example": "Verified",
"type": "string"
},
"marketplaceUsernames": {
"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"
},
{
"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"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/MarketplaceUsername"
}
},
"tags": {
"example": [
{
"tagId": 1234,
"name": "Expedited"
},
{
"tagId": 9725,
"name": "00 BULK ORDERED"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"required": [
"customerId",
"createDate",
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"countryCode",
"phone",
"email",
"addressVerified",
"marketplaceUsernames",
"tags"
]
},
"ListFulfillmentsw/oparametersresponse": {
"title": "ListFulfillmentsw/oparametersresponse",
"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
},
"type": "object",
"properties": {
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/definitions/Fulfillment"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"fulfillments",
"total",
"page",
"pages"
]
},
"Fulfillment": {
"title": "Fulfillment",
"type": "object",
"properties": {
"fulfillmentId": {
"example": 33974374,
"type": "integer",
"format": "int32"
},
"orderId": {
"example": 191759016,
"type": "integer",
"format": "int32"
},
"orderNumber": {
"example": "101",
"type": "string"
},
"userId": {
"example": "c9f06d74-95de-4263-9b04-e87095cababf",
"type": "string"
},
"customerEmail": {
"example": "apisupport@shipstation.com",
"type": "string"
},
"trackingNumber": {
"example": "783408231234",
"type": "string"
},
"createDate": {
"example": "6/7/2016 8:50:50 AM",
"type": "string"
},
"shipDate": {
"example": "6/7/2016 12:00:00 AM",
"type": "string"
},
"voidDate": {
"type": "string"
},
"deliveryDate": {
"type": "string"
},
"carrierCode": {
"example": "USPS",
"type": "string"
},
"fulfillmentProviderCode": {
"type": "string"
},
"fulfillmentServiceCode": {
"type": "string"
},
"fulfillmentFee": {
"example": 0,
"type": "integer",
"format": "int32"
},
"voidRequested": {
"example": false,
"type": "boolean"
},
"voided": {
"example": false,
"type": "boolean"
},
"marketplaceNotified": {
"example": true,
"type": "boolean"
},
"notifyErrorMessage": {
"type": "string"
},
"shipTo": {
"$ref": "#/definitions/ShipTo"
}
},
"required": [
"fulfillmentId",
"orderId",
"orderNumber",
"userId",
"customerEmail",
"trackingNumber",
"createDate",
"shipDate",
"carrierCode",
"fulfillmentFee",
"voidRequested",
"voided",
"marketplaceNotified",
"shipTo"
]
},
"ShipTo": {
"title": "ShipTo",
"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
},
"type": "object",
"properties": {
"name": {
"example": "Yoda",
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"example": "3800 N Lamar Blvd # 220",
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string"
},
"city": {
"example": "AUSTIN",
"type": "string"
},
"state": {
"example": "TX",
"type": "string"
},
"postalCode": {
"example": "78756",
"type": "string"
},
"country": {
"example": "US",
"type": "string"
},
"phone": {
"example": "512-485-4282",
"type": "string"
},
"residential": {
"type": "string"
},
"addressVerified": {
"type": "string"
}
},
"required": [
"name",
"street1",
"city",
"state",
"postalCode",
"country",
"phone"
]
},
"sortBy1": {
"title": "sortBy1",
"example": "ShipDate",
"type": "string",
"enum": [
"ShipDate",
"CreateDate"
]
},
"ListFulfillmentswithparametersresponse": {
"title": "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
},
"type": "object",
"properties": {
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/definitions/Fulfillment"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"fulfillments",
"total",
"page",
"pages"
]
},
"GetOrderresponse": {
"title": "GetOrderresponse",
"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": "#/definitions/BillTo"
},
"shipTo": {
"$ref": "#/definitions/ShipTo2"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/Item"
}
},
"orderTotal": {
"type": "number",
"format": "double"
},
"amountPaid": {
"type": "number",
"format": "double"
},
"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"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/definitions/InternationalOptions"
},
"advancedOptions": {
"$ref": "#/definitions/AdvancedOptions"
},
"tagIds": {
"type": "string"
},
"userId": {
"type": "string"
},
"externallyFulfilled": {
"type": "boolean"
},
"externallyFulfilledBy": {
"type": "string"
}
},
"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"
]
},
"BillTo": {
"title": "BillTo",
"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
},
"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"
},
"addressVerified": {
"type": "string"
}
},
"required": [
"name"
]
},
"ShipTo2": {
"title": "ShipTo2",
"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"
},
"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"
},
"addressVerified": {
"type": "string"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"phone",
"residential",
"addressVerified"
]
},
"Item": {
"title": "Item",
"type": "object",
"properties": {
"orderItemId": {
"example": 128836912,
"type": "integer",
"format": "int32"
},
"lineItemKey": {
"example": "vd08-MSLbtx",
"type": "string"
},
"sku": {
"example": "ABC123",
"type": "string"
},
"name": {
"example": "Test item #1",
"type": "string"
},
"imageUrl": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"quantity": {
"example": 2,
"type": "integer",
"format": "int32"
},
"unitPrice": {
"example": 99.99,
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "string"
},
"shippingAmount": {
"type": "string"
},
"warehouseLocation": {
"example": "Aisle 1, Bin 7",
"type": "string"
},
"options": {
"example": [
{
"name": "Size",
"value": "Large"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Option"
}
},
"productId": {
"example": 7239919,
"type": "integer",
"format": "int32"
},
"fulfillmentSku": {
"type": "string"
},
"adjustment": {
"example": false,
"type": "boolean"
},
"upc": {
"type": "string"
},
"createDate": {
"example": "7/16/2015 2:00:34 PM",
"type": "string"
},
"modifyDate": {
"example": "7/16/2015 2:00:34 PM",
"type": "string"
}
},
"required": [
"orderItemId",
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"warehouseLocation",
"options",
"productId",
"adjustment",
"createDate",
"modifyDate"
]
},
"Weight": {
"title": "Weight",
"example": {
"value": 24,
"units": "ounces"
},
"type": "object",
"properties": {
"value": {
"example": 24,
"type": "integer",
"format": "int32"
},
"units": {
"example": "ounces",
"type": "string"
}
},
"required": [
"value",
"units"
]
},
"Option": {
"title": "Option",
"example": {
"name": "Size",
"value": "Large"
},
"type": "object",
"properties": {
"name": {
"example": "Size",
"type": "string"
},
"value": {
"example": "Large",
"type": "string"
}
}
},
"Dimensions": {
"title": "Dimensions",
"example": {
"units": "inches",
"length": 7,
"width": 5,
"height": 6
},
"type": "object",
"properties": {
"units": {
"type": "string"
},
"length": {
"type": "integer",
"format": "int32"
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
}
},
"required": [
"units",
"length",
"width",
"height"
]
},
"InsuranceOptions": {
"title": "InsuranceOptions",
"example": {
"provider": "carrier",
"insureShipment": true,
"insuredValue": 200
},
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"insureShipment": {
"type": "boolean"
},
"insuredValue": {
"type": "integer",
"format": "int32"
}
},
"required": [
"provider",
"insureShipment",
"insuredValue"
]
},
"InternationalOptions": {
"title": "InternationalOptions",
"example": {
"contents": null,
"customsItems": null,
"nonDelivery": null
},
"type": "object",
"properties": {
"contents": {
"type": "string"
},
"customsItems": {
"type": "string"
},
"nonDelivery": {
"type": "string"
}
}
},
"AdvancedOptions": {
"title": "AdvancedOptions",
"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
},
"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"
}
},
"parentId": {
"type": "string"
},
"storeId": {
"type": "integer",
"format": "int32"
},
"customField1": {
"type": "string"
},
"customField2": {
"type": "string"
},
"customField3": {
"type": "string"
},
"source": {
"type": "string"
},
"billToParty": {
"type": "string"
},
"billToAccount": {
"type": "string"
},
"billToPostalCode": {
"type": "string"
},
"billToCountryCode": {
"type": "string"
}
},
"required": [
"warehouseId",
"nonMachinable",
"saturdayDelivery",
"containsAlcohol",
"mergedOrSplit",
"mergedIds",
"storeId",
"customField1",
"customField2",
"customField3",
"source"
]
},
"DeleteOrderresponse": {
"title": "DeleteOrderresponse",
"example": {
"success": true,
"message": "The requested order has been deleted."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"AddTagtoOrderrequest": {
"title": "AddTagtoOrderrequest",
"example": {
"orderId": 123456,
"tagId": 1234
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"tagId": {
"type": "integer",
"format": "int32"
}
},
"required": [
"orderId",
"tagId"
]
},
"AddTagtoOrderresponse": {
"title": "AddTagtoOrderresponse",
"example": {
"success": true,
"message": "Tag added successfully."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"AssignUsertoOrderrequest": {
"title": "AssignUsertoOrderrequest",
"example": {
"orderIds": [
123456789,
12345679
],
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa"
},
"type": "object",
"properties": {
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"userId": {
"type": "string"
}
},
"required": [
"orderIds",
"userId"
]
},
"AssignUsertoOrderresponse": {
"title": "AssignUsertoOrderresponse",
"example": {
"success": true,
"message": "User assigned successfully."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"CreateLabelforOrderrequest": {
"title": "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
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"type": "string"
},
"insuranceOptions": {
"type": "string"
},
"internationalOptions": {
"type": "string"
},
"advancedOptions": {
"type": "string"
},
"testLabel": {
"type": "boolean"
}
},
"required": [
"orderId",
"carrierCode",
"serviceCode",
"packageCode",
"shipDate",
"weight",
"testLabel"
]
},
"CreateLabelforOrderresponse": {
"title": "CreateLabelforOrderresponse",
"example": {
"shipmentId": 72513480,
"shipmentCost": 7.3,
"insuranceCost": 0,
"trackingNumber": "248201115029520",
"labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC9MZW5ndGggNjIvRmlsdGVyL0ZsYXRlRGVjb2RlPj5zdHJlYW0KeJwr5HIK4TI2UzC2NFMISeFyDeEK5CpUMFQwAEJDBV0jCz0LBV1jY0M9I4XkXAX9iDRDBZd8hUAuAEdGC7cKZW5kc3RyZWFtCmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveFswIDAgMjg4IDQzMl0vUmVzb3VyY2VzPDwvUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0vWE9iamVjdDw8L1hmMSAxIDAgUj4+Pj4vQ29udGVudHMgMiAwIFIvUGFyZW50....",
"formData": null
},
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32"
},
"shipmentCost": {
"type": "number",
"format": "double"
},
"insuranceCost": {
"type": "integer",
"format": "int32"
},
"trackingNumber": {
"type": "string"
},
"labelData": {
"type": "string"
},
"formData": {
"type": "string"
}
},
"required": [
"shipmentId",
"shipmentCost",
"insuranceCost",
"trackingNumber",
"labelData"
]
},
"Create/UpdateOrderrequest": {
"title": "Create/UpdateOrderrequest",
"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": "#/definitions/BillTo1"
},
"shipTo": {
"$ref": "#/definitions/ShipTo3"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/Item1"
}
},
"amountPaid": {
"type": "number",
"format": "double"
},
"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": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/definitions/InternationalOptions1"
},
"advancedOptions": {
"$ref": "#/definitions/AdvancedOptions"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"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"
]
},
"BillTo1": {
"title": "BillTo1",
"example": {
"name": "The President",
"company": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"state": null,
"postalCode": null,
"country": null,
"phone": null,
"residential": null
},
"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"
}
},
"required": [
"name"
]
},
"ShipTo3": {
"title": "ShipTo3",
"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
},
"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"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
]
},
"Item1": {
"title": "Item1",
"type": "object",
"properties": {
"lineItemKey": {
"example": "vd08-MSLbtx",
"type": "string"
},
"sku": {
"example": "ABC123",
"type": "string"
},
"name": {
"example": "Test item #1",
"type": "string"
},
"imageUrl": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"quantity": {
"example": 2,
"type": "integer",
"format": "int32"
},
"unitPrice": {
"example": 99.99,
"type": "number",
"format": "double"
},
"taxAmount": {
"example": 2.5,
"type": "number",
"format": "double"
},
"shippingAmount": {
"example": 5,
"type": "number",
"format": "double"
},
"warehouseLocation": {
"example": "Aisle 1, Bin 7",
"type": "string"
},
"options": {
"example": [
{
"name": "Size",
"value": "Large"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Option"
}
},
"productId": {
"example": 123456,
"type": "integer",
"format": "int32"
},
"fulfillmentSku": {
"type": "string"
},
"adjustment": {
"example": false,
"type": "boolean"
},
"upc": {
"example": "32-65-98",
"type": "string"
}
},
"required": [
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"taxAmount",
"shippingAmount",
"warehouseLocation",
"options",
"productId",
"adjustment",
"upc"
]
},
"InternationalOptions1": {
"title": "InternationalOptions1",
"example": {
"contents": null,
"customsItems": null
},
"type": "object",
"properties": {
"contents": {
"type": "string"
},
"customsItems": {
"type": "string"
}
}
},
"Create/UpdateOrderresponse": {
"title": "Create/UpdateOrderresponse",
"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"
},
"customerUsername": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"billTo": {
"$ref": "#/definitions/BillTo"
},
"shipTo": {
"$ref": "#/definitions/ShipTo2"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/Item2"
}
},
"orderTotal": {
"type": "number",
"format": "double"
},
"amountPaid": {
"type": "number",
"format": "double"
},
"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"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/definitions/InternationalOptions"
},
"advancedOptions": {
"$ref": "#/definitions/AdvancedOptions"
},
"tagIds": {
"type": "string"
},
"userId": {
"type": "string"
},
"externallyFulfilled": {
"type": "boolean"
},
"externallyFulfilledBy": {
"type": "string"
}
},
"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"
]
},
"Item2": {
"title": "Item2",
"type": "object",
"properties": {
"orderItemId": {
"example": 192210956,
"type": "integer",
"format": "int32"
},
"lineItemKey": {
"example": "vd08-MSLbtx",
"type": "string"
},
"sku": {
"example": "ABC123",
"type": "string"
},
"name": {
"example": "Test item #1",
"type": "string"
},
"imageUrl": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"quantity": {
"example": 2,
"type": "integer",
"format": "int32"
},
"unitPrice": {
"example": 99.99,
"type": "number",
"format": "double"
},
"taxAmount": {
"example": 2.5,
"type": "number",
"format": "double"
},
"shippingAmount": {
"example": 5,
"type": "integer",
"format": "int32"
},
"warehouseLocation": {
"example": "Aisle 1, Bin 7",
"type": "string"
},
"options": {
"example": [
{
"name": "Size",
"value": "Large"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Option"
}
},
"productId": {
"type": "string"
},
"fulfillmentSku": {
"type": "string"
},
"adjustment": {
"example": false,
"type": "boolean"
},
"upc": {
"example": "32-65-98",
"type": "string"
},
"createDate": {
"example": "2/16/2016 3:16:53 PM",
"type": "string"
},
"modifyDate": {
"example": "2/16/2016 3:16:53 PM",
"type": "string"
}
},
"required": [
"orderItemId",
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"taxAmount",
"shippingAmount",
"warehouseLocation",
"options",
"adjustment",
"upc",
"createDate",
"modifyDate"
]
},
"Create/UpdateMultipleOrdersrequest": {
"title": "Create/UpdateMultipleOrdersrequest",
"type": "object",
"properties": {
"orderNumber": {
"example": "TEST-ORDER-API-DOCS",
"type": "string"
},
"orderKey": {
"example": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"type": "string"
},
"orderDate": {
"example": "6/29/2015 8:46:27 AM",
"type": "string"
},
"paymentDate": {
"example": "6/29/2015 8:46:27 AM",
"type": "string"
},
"shipByDate": {
"example": "7/5/2015 12:00:00 AM",
"type": "string"
},
"orderStatus": {
"example": "awaiting_shipment",
"type": "string"
},
"customerId": {
"example": 37701499,
"type": "integer",
"format": "int32"
},
"customerUsername": {
"example": "headhoncho@whitehouse.gov",
"type": "string"
},
"customerEmail": {
"example": "headhoncho@whitehouse.gov",
"type": "string"
},
"billTo": {
"$ref": "#/definitions/BillTo1"
},
"shipTo": {
"$ref": "#/definitions/ShipTo3"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/Item1"
}
},
"amountPaid": {
"example": 218.73,
"type": "number",
"format": "double"
},
"taxAmount": {
"example": 5,
"type": "integer",
"format": "int32"
},
"shippingAmount": {
"example": 10,
"type": "integer",
"format": "int32"
},
"customerNotes": {
"example": "Please ship as soon as possible!",
"type": "string"
},
"internalNotes": {
"example": "Customer called and would like to upgrade shipping",
"type": "string"
},
"gift": {
"example": true,
"type": "boolean"
},
"giftMessage": {
"example": "Thank you!",
"type": "string"
},
"paymentMethod": {
"example": "Credit Card",
"type": "string"
},
"requestedShippingService": {
"example": "Priority Mail",
"type": "string"
},
"carrierCode": {
"example": "fedex",
"type": "string"
},
"serviceCode": {
"example": "fedex_2day",
"type": "string"
},
"packageCode": {
"example": "package",
"type": "string"
},
"confirmation": {
"example": "delivery",
"type": "string"
},
"shipDate": {
"example": "2015-07-02",
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/definitions/InternationalOptions1"
},
"advancedOptions": {
"$ref": "#/definitions/AdvancedOptions"
},
"tagIds": {
"example": [
53974
],
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"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"
]
},
"Create/UpdateMultipleOrdersresponse": {
"title": "Create/UpdateMultipleOrdersresponse",
"example": {
"hasErrors": false,
"results": [
{
"orderId": 58345234,
"orderNumber": "TEST-ORDER-API-DOCS",
"orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"success": true,
"errorMessage": null
}
]
},
"type": "object",
"properties": {
"hasErrors": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/Result"
}
}
},
"required": [
"hasErrors",
"results"
]
},
"Result": {
"title": "Result",
"type": "object",
"properties": {
"orderId": {
"example": 58345234,
"type": "integer",
"format": "int32"
},
"orderNumber": {
"example": "TEST-ORDER-API-DOCS",
"type": "string"
},
"orderKey": {
"example": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"type": "string"
},
"success": {
"example": true,
"type": "boolean"
},
"errorMessage": {
"type": "string"
}
},
"required": [
"orderId",
"orderNumber",
"orderKey",
"success"
]
},
"HoldOrderUntilrequest": {
"title": "HoldOrderUntilrequest",
"example": {
"orderId": 1072467,
"holdUntilDate": "2014-12-01"
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"holdUntilDate": {
"type": "string"
}
},
"required": [
"orderId",
"holdUntilDate"
]
},
"HoldOrderUntilresponse": {
"title": "HoldOrderUntilresponse",
"example": {
"success": true,
"message": "Order held successfully."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"ListOrdersw/oparametersresponse": {
"title": "ListOrdersw/oparametersresponse",
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/definitions/Order"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"orders",
"total",
"page",
"pages"
]
},
"Order": {
"title": "Order",
"type": "object",
"properties": {
"orderId": {
"example": 987654321,
"type": "integer",
"format": "int32"
},
"orderNumber": {
"example": "Test-International-API-DOCS",
"type": "string"
},
"orderKey": {
"example": "Test-International-API-DOCS",
"type": "string"
},
"orderDate": {
"example": "6/28/2015 5:46:27 PM",
"type": "string"
},
"createDate": {
"example": "8/17/2015 9:24:14 AM",
"type": "string"
},
"modifyDate": {
"example": "8/17/2015 9:24:16 AM",
"type": "string"
},
"paymentDate": {
"example": "6/28/2015 5:46:27 PM",
"type": "string"
},
"shipByDate": {
"example": "7/5/2015 12:00:00 AM",
"type": "string"
},
"orderStatus": {
"example": "awaiting_shipment",
"type": "string"
},
"customerId": {
"example": 63310475,
"type": "integer",
"format": "int32"
},
"customerUsername": {
"example": "sholmes1854@methodsofdetection.com",
"type": "string"
},
"customerEmail": {
"example": "sholmes1854@methodsofdetection.com",
"type": "string"
},
"billTo": {
"$ref": "#/definitions/BillTo"
},
"shipTo": {
"$ref": "#/definitions/ShipTo6"
},
"items": {
"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\""
},
{
"orderItemId": 136282569,
"lineItemKey": "null",
"sku": "CN-9876",
"name": "Fine White Oak Cane",
"imageUrl": "null",
"weight": {
"value": 80,
"units": "ounces"
},
"quantity": 1,
"unitPrice": 225,
"taxAmount": "null",
"shippingAmount": "null",
"warehouseLocation": "Aisle 7, Bin 34",
"options": [],
"productId": 11780609,
"fulfillmentSku": "null",
"adjustment": false,
"upc": "null",
"createDate": "\"2015-08-17T09:24:14.78\"",
"modifyDate": "\"2015-08-17T09:24:14.78\""
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Item4"
}
},
"orderTotal": {
"example": 387.97,
"type": "number",
"format": "double"
},
"amountPaid": {
"example": 412.97,
"type": "number",
"format": "double"
},
"taxAmount": {
"example": 27.99,
"type": "number",
"format": "double"
},
"shippingAmount": {
"example": 35,
"type": "integer",
"format": "int32"
},
"customerNotes": {
"example": "Please be careful when packing the disguise kits in with the cane.",
"type": "string"
},
"internalNotes": {
"example": "Mr. Holmes called to upgrade his shipping to expedited",
"type": "string"
},
"gift": {
"example": false,
"type": "boolean"
},
"giftMessage": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"requestedShippingService": {
"example": "Priority Mail Int",
"type": "string"
},
"carrierCode": {
"example": "stamps_com",
"type": "string"
},
"serviceCode": {
"example": "usps_priority_mail_international",
"type": "string"
},
"packageCode": {
"example": "package",
"type": "string"
},
"confirmation": {
"example": "delivery",
"type": "string"
},
"shipDate": {
"example": "2015-04-25",
"type": "string"
},
"holdUntilDate": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions4"
},
"internationalOptions": {
"$ref": "#/definitions/InternationalOptions4"
},
"advancedOptions": {
"$ref": "#/definitions/AdvancedOptions4"
},
"tagIds": {
"type": "string"
},
"userId": {
"type": "string"
},
"externallyFulfilled": {
"example": false,
"type": "boolean"
},
"externallyFulfilledBy": {
"type": "string"
}
},
"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"
]
},
"ShipTo6": {
"title": "ShipTo6",
"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"
},
"type": "object",
"properties": {
"name": {
"example": "Sherlock Holmes",
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"example": "221 B Baker St",
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string"
},
"city": {
"example": "London",
"type": "string"
},
"state": {
"type": "string"
},
"postalCode": {
"example": "NW1 6XE",
"type": "string"
},
"country": {
"example": "GB",
"type": "string"
},
"phone": {
"type": "string"
},
"residential": {
"example": true,
"type": "boolean"
},
"addressVerified": {
"example": "Address not yet validated",
"type": "string"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"residential",
"addressVerified"
]
},
"Item4": {
"title": "Item4",
"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\""
},
"type": "object",
"properties": {
"orderItemId": {
"example": 136282568,
"type": "integer",
"format": "int32"
},
"lineItemKey": {
"type": "string"
},
"sku": {
"example": "Ele-1234",
"type": "string"
},
"name": {
"example": "Elementary Disguise Kit",
"type": "string"
},
"imageUrl": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"quantity": {
"example": 2,
"type": "integer",
"format": "int32"
},
"unitPrice": {
"example": 49.99,
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "string"
},
"shippingAmount": {
"type": "string"
},
"warehouseLocation": {
"example": "Aisle 1, Bin 7",
"type": "string"
},
"options": {
"example": [],
"type": "array",
"items": {
"$ref": "#/definitions/Option"
}
},
"productId": {
"example": 11780610,
"type": "integer",
"format": "int32"
},
"fulfillmentSku": {
"example": "Ele-1234",
"type": "string"
},
"adjustment": {
"example": false,
"type": "boolean"
},
"upc": {
"type": "string"
},
"createDate": {
"example": "8/17/2015 9:24:14 AM",
"type": "string"
},
"modifyDate": {
"example": "8/17/2015 9:24:14 AM",
"type": "string"
}
},
"required": [
"orderItemId",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"warehouseLocation",
"options",
"productId",
"fulfillmentSku",
"adjustment",
"createDate",
"modifyDate"
]
},
"InsuranceOptions4": {
"title": "InsuranceOptions4",
"example": {
"provider": null,
"insureShipment": false,
"insuredValue": 0
},
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"insureShipment": {
"example": false,
"type": "boolean"
},
"insuredValue": {
"example": 0,
"type": "integer",
"format": "int32"
}
},
"required": [
"insureShipment",
"insuredValue"
]
},
"InternationalOptions4": {
"title": "InternationalOptions4",
"type": "object",
"properties": {
"contents": {
"example": "merchandise",
"type": "string"
},
"customsItems": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomsItem"
}
},
"nonDelivery": {
"example": "return_to_sender",
"type": "string"
}
},
"required": [
"contents",
"customsItems",
"nonDelivery"
]
},
"CustomsItem": {
"title": "CustomsItem",
"type": "object",
"properties": {
"customsItemId": {
"example": 11558268,
"type": "integer",
"format": "int32"
},
"description": {
"example": "Fine White Oak Cane",
"type": "string"
},
"quantity": {
"example": 1,
"type": "integer",
"format": "int32"
},
"value": {
"example": 225,
"type": "integer",
"format": "int32"
},
"harmonizedTariffCode": {
"type": "string"
},
"countryOfOrigin": {
"example": "US",
"type": "string"
}
},
"required": [
"customsItemId",
"description",
"quantity",
"value",
"countryOfOrigin"
]
},
"AdvancedOptions4": {
"title": "AdvancedOptions4",
"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
},
"type": "object",
"properties": {
"warehouseId": {
"example": 98765,
"type": "integer",
"format": "int32"
},
"nonMachinable": {
"example": false,
"type": "boolean"
},
"saturdayDelivery": {
"example": false,
"type": "boolean"
},
"containsAlcohol": {
"example": false,
"type": "boolean"
},
"mergedOrSplit": {
"example": false,
"type": "boolean"
},
"mergedIds": {
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"parentId": {
"type": "string"
},
"storeId": {
"example": 12345,
"type": "integer",
"format": "int32"
},
"customField1": {
"example": "SKU: CN-9876 x 1",
"type": "string"
},
"customField2": {
"example": "SKU: Ele-123 x 2",
"type": "string"
},
"customField3": {
"type": "string"
},
"source": {
"type": "string"
},
"billToParty": {
"type": "string"
},
"billToAccount": {
"type": "string"
},
"billToPostalCode": {
"type": "string"
},
"billToCountryCode": {
"type": "string"
}
},
"required": [
"warehouseId",
"nonMachinable",
"saturdayDelivery",
"containsAlcohol",
"mergedOrSplit",
"mergedIds",
"storeId",
"customField1",
"customField2"
]
},
"orderStatus": {
"title": "orderStatus",
"example": "awaiting_payment",
"type": "string",
"enum": [
"awaiting_payment",
"awaiting_shipment",
"pending_fulfillment",
"shipped",
"on_hold",
"cancelled"
]
},
"sortBy2": {
"title": "sortBy2",
"example": "OrderDate",
"type": "string",
"enum": [
"OrderDate",
"ModifyDate",
"CreateDate"
]
},
"ListOrderswithparametersresponse": {
"title": "ListOrderswithparametersresponse",
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/definitions/Order"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"orders",
"total",
"page",
"pages"
]
},
"ListOrdersbyTagresponse": {
"title": "ListOrdersbyTagresponse",
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/definitions/Order2"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"orders",
"total",
"page",
"pages"
]
},
"Order2": {
"title": "Order2",
"type": "object",
"properties": {
"orderId": {
"example": 123456789,
"type": "integer",
"format": "int32"
},
"orderNumber": {
"example": "TEST-ORDER-API-DOCS",
"type": "string"
},
"orderKey": {
"example": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
"type": "string"
},
"orderDate": {
"example": "6/29/2015 8:46:27 AM",
"type": "string"
},
"createDate": {
"example": "8/17/2015 9:43:03 AM",
"type": "string"
},
"modifyDate": {
"example": "8/17/2015 9:43:12 AM",
"type": "string"
},
"paymentDate": {
"example": "6/29/2015 8:46:27 AM",
"type": "string"
},
"shipByDate": {
"example": "7/5/2015 12:00:00 AM",
"type": "string"
},
"orderStatus": {
"example": "awaiting_shipment",
"type": "string"
},
"customerId": {
"example": 37701499,
"type": "integer",
"format": "int32"
},
"customerUsername": {
"example": "headhoncho@whitehouse.gov",
"type": "string"
},
"customerEmail": {
"example": "headhoncho@whitehouse.gov",
"type": "string"
},
"billTo": {
"$ref": "#/definitions/BillTo"
},
"shipTo": {
"$ref": "#/definitions/ShipTo2"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/Item6"
}
},
"orderTotal": {
"example": 194.43,
"type": "number",
"format": "double"
},
"amountPaid": {
"example": 218.73,
"type": "number",
"format": "double"
},
"taxAmount": {
"example": 5,
"type": "integer",
"format": "int32"
},
"shippingAmount": {
"example": 10,
"type": "integer",
"format": "int32"
},
"customerNotes": {
"example": "Please ship as soon as possible!",
"type": "string"
},
"internalNotes": {
"example": "Customer called and would like to upgrade shipping",
"type": "string"
},
"gift": {
"example": true,
"type": "boolean"
},
"giftMessage": {
"example": "Thank you!",
"type": "string"
},
"paymentMethod": {
"example": "Credit Card",
"type": "string"
},
"requestedShippingService": {
"example": "Priority Mail",
"type": "string"
},
"carrierCode": {
"example": "fedex",
"type": "string"
},
"serviceCode": {
"example": "fedex_2day",
"type": "string"
},
"packageCode": {
"example": "package",
"type": "string"
},
"confirmation": {
"example": "delivery",
"type": "string"
},
"shipDate": {
"example": "2015-07-02",
"type": "string"
},
"holdUntilDate": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions"
},
"internationalOptions": {
"$ref": "#/definitions/InternationalOptions"
},
"advancedOptions": {
"$ref": "#/definitions/AdvancedOptions"
},
"tagIds": {
"example": [
831
],
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"userId": {
"example": "b854f701-e0c2-4156-90fe-19c77cdef27c",
"type": "string"
},
"externallyFulfilled": {
"example": false,
"type": "boolean"
},
"externallyFulfilledBy": {
"type": "string"
}
},
"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"
]
},
"Item6": {
"title": "Item6",
"type": "object",
"properties": {
"orderItemId": {
"example": 136289188,
"type": "integer",
"format": "int32"
},
"lineItemKey": {
"example": "vd08-MSLbtx",
"type": "string"
},
"sku": {
"example": "ABC123",
"type": "string"
},
"name": {
"example": "Test item #1",
"type": "string"
},
"imageUrl": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"quantity": {
"example": 2,
"type": "integer",
"format": "int32"
},
"unitPrice": {
"example": 99.99,
"type": "number",
"format": "double"
},
"taxAmount": {
"example": 2.5,
"type": "number",
"format": "double"
},
"shippingAmount": {
"example": 5,
"type": "integer",
"format": "int32"
},
"warehouseLocation": {
"example": "Aisle 1, Bin 7",
"type": "string"
},
"options": {
"example": [
{
"name": "Size",
"value": "Large"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Option"
}
},
"productId": {
"example": 7239919,
"type": "integer",
"format": "int32"
},
"fulfillmentSku": {
"type": "string"
},
"adjustment": {
"example": false,
"type": "boolean"
},
"upc": {
"example": "32-65-98",
"type": "string"
},
"createDate": {
"example": "8/17/2015 9:43:03 AM",
"type": "string"
},
"modifyDate": {
"example": "8/17/2015 9:43:03 AM",
"type": "string"
}
},
"required": [
"orderItemId",
"lineItemKey",
"sku",
"name",
"weight",
"quantity",
"unitPrice",
"taxAmount",
"shippingAmount",
"warehouseLocation",
"options",
"productId",
"adjustment",
"upc",
"createDate",
"modifyDate"
]
},
"MarkanOrderasShippedrequest": {
"title": "MarkanOrderasShippedrequest",
"example": {
"orderId": 93348442,
"carrierCode": "usps",
"shipDate": "2014-04-01",
"trackingNumber": "913492493294329421",
"notifyCustomer": true,
"notifySalesChannel": true
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"carrierCode": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"notifyCustomer": {
"type": "boolean"
},
"notifySalesChannel": {
"type": "boolean"
}
},
"required": [
"orderId",
"carrierCode",
"shipDate",
"trackingNumber",
"notifyCustomer",
"notifySalesChannel"
]
},
"MarkanOrderasShippedresponse": {
"title": "MarkanOrderasShippedresponse",
"example": {
"orderId": 123456789,
"orderNumber": "ABC123"
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"orderNumber": {
"type": "string"
}
},
"required": [
"orderId",
"orderNumber"
]
},
"RemoveTagfromOrderrequest": {
"title": "RemoveTagfromOrderrequest",
"example": {
"orderId": 123456,
"tagId": 1234
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
},
"tagId": {
"type": "integer",
"format": "int32"
}
},
"required": [
"orderId",
"tagId"
]
},
"RemoveTagfromOrderresponse": {
"title": "RemoveTagfromOrderresponse",
"example": {
"success": true,
"message": "Tag removed successfully."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"RestoreOrderfromOnHoldrequest": {
"title": "RestoreOrderfromOnHoldrequest",
"example": {
"orderId": 1234567
},
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int32"
}
},
"required": [
"orderId"
]
},
"RestoreOrderfromOnHoldresponse": {
"title": "RestoreOrderfromOnHoldresponse",
"example": {
"success": true,
"message": "The requested order has been restored"
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"UnassignUserfromOrderrequest": {
"title": "UnassignUserfromOrderrequest",
"example": {
"orderIds": [
123456789,
12345679
]
},
"type": "object",
"properties": {
"orderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"required": [
"orderIds"
]
},
"UnassignUserfromOrderresponse": {
"title": "UnassignUserfromOrderresponse",
"example": {
"success": true,
"message": "User unassigned successfully."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"GetProductresponse": {
"title": "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"
}
]
},
"type": "object",
"properties": {
"aliases": {
"type": "string"
},
"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"
},
"fulfillmentSku": {
"type": "string"
},
"createDate": {
"type": "string"
},
"modifyDate": {
"type": "string"
},
"active": {
"type": "boolean"
},
"productCategory": {
"$ref": "#/definitions/ProductCategory"
},
"productType": {
"type": "string"
},
"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"
},
"customsValue": {
"type": "string"
},
"customsTariffNo": {
"type": "string"
},
"customsCountryCode": {
"type": "string"
},
"noCustoms": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"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"
]
},
"ProductCategory": {
"title": "ProductCategory",
"example": {
"categoryId": 9999,
"name": "Door Closers"
},
"type": "object",
"properties": {
"categoryId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
}
},
"required": [
"categoryId",
"name"
]
},
"UpdateProductrequest": {
"title": "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
},
"type": "object",
"properties": {
"aliases": {
"type": "string"
},
"productId": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"name": {
"type": "string"
},
"price": {
"type": "integer",
"format": "int32"
},
"defaultCost": {
"type": "string"
},
"length": {
"type": "string"
},
"width": {
"type": "string"
},
"height": {
"type": "string"
},
"weightOz": {
"type": "string"
},
"internalNotes": {
"type": "string"
},
"fulfillmentSku": {
"type": "string"
},
"active": {
"type": "boolean"
},
"productCategory": {
"type": "string"
},
"productType": {
"type": "string"
},
"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"
},
"customsValue": {
"type": "string"
},
"customsTariffNo": {
"type": "string"
},
"customsCountryCode": {
"type": "string"
},
"noCustoms": {
"type": "string"
},
"tags": {
"type": "string"
}
},
"required": [
"productId",
"sku",
"name",
"price",
"active"
]
},
"UpdateProductresponse": {
"title": "UpdateProductresponse",
"example": {
"success": true,
"message": "The requested product has been updated"
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"ListProductsw/oparametersresponse": {
"title": "ListProductsw/oparametersresponse",
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/definitions/Product"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"products",
"total",
"page",
"pages"
]
},
"Product": {
"title": "Product",
"type": "object",
"properties": {
"aliases": {
"type": "string"
},
"productId": {
"example": 7854008,
"type": "integer",
"format": "int32"
},
"sku": {
"example": "1004",
"type": "string"
},
"name": {
"example": "Coffee Mug",
"type": "string"
},
"price": {
"example": 26,
"type": "integer",
"format": "int32"
},
"defaultCost": {
"example": 0,
"type": "integer",
"format": "int32"
},
"length": {
"example": 3,
"type": "integer",
"format": "int32"
},
"width": {
"example": 3,
"type": "integer",
"format": "int32"
},
"height": {
"example": 3,
"type": "integer",
"format": "int32"
},
"weightOz": {
"example": 26,
"type": "integer",
"format": "int32"
},
"internalNotes": {
"type": "string"
},
"fulfillmentSku": {
"example": "F1004",
"type": "string"
},
"createDate": {
"example": "9/4/2014 9:18:01 AM",
"type": "string"
},
"modifyDate": {
"example": "9/18/2014 12:38:43 PM",
"type": "string"
},
"active": {
"example": true,
"type": "boolean"
},
"productCategory": {
"$ref": "#/definitions/ProductCategory"
},
"productType": {
"type": "string"
},
"warehouseLocation": {
"example": "Bin 22",
"type": "string"
},
"defaultCarrierCode": {
"example": "fedex",
"type": "string"
},
"defaultServiceCode": {
"example": "fedex_home_delivery",
"type": "string"
},
"defaultPackageCode": {
"example": "package",
"type": "string"
},
"defaultIntlCarrierCode": {
"example": "ups",
"type": "string"
},
"defaultIntlServiceCode": {
"example": "ups_worldwide_saver",
"type": "string"
},
"defaultIntlPackageCode": {
"example": "package",
"type": "string"
},
"defaultConfirmation": {
"example": "direct_signature",
"type": "string"
},
"defaultIntlConfirmation": {
"example": "adult_signature",
"type": "string"
},
"customsDescription": {
"type": "string"
},
"customsValue": {
"type": "string"
},
"customsTariffNo": {
"type": "string"
},
"customsCountryCode": {
"type": "string"
},
"noCustoms": {
"type": "string"
},
"tags": {
"example": [
{
"tagId": 9180,
"name": "APItest"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
}
},
"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"
]
},
"sortBy3": {
"title": "sortBy3",
"example": "SKU",
"type": "string",
"enum": [
"SKU",
"ModifyDate",
"CreateDate"
]
},
"ListProductswithparametersresponse": {
"title": "ListProductswithparametersresponse",
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/definitions/Product"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"products",
"total",
"page",
"pages"
]
},
"ListShipmentsw/oparametersresponse": {
"title": "ListShipmentsw/oparametersresponse",
"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
},
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/definitions/Shipment"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"shipments",
"total",
"page",
"pages"
]
},
"Shipment": {
"title": "Shipment",
"type": "object",
"properties": {
"shipmentId": {
"example": 33974374,
"type": "integer",
"format": "int32"
},
"orderId": {
"example": 43945660,
"type": "integer",
"format": "int32"
},
"orderKey": {
"example": "8061c220f0794a9b92460b8bae6837e4",
"type": "string"
},
"userId": {
"example": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"type": "string"
},
"orderNumber": {
"example": "100038-1",
"type": "string"
},
"createDate": {
"example": "10/3/2014 6:51:33 AM",
"type": "string"
},
"shipDate": {
"example": "2014-10-03",
"type": "string"
},
"shipmentCost": {
"example": 1.93,
"type": "number",
"format": "double"
},
"insuranceCost": {
"example": 0,
"type": "integer",
"format": "int32"
},
"trackingNumber": {
"example": "9400111899561704681189",
"type": "string"
},
"isReturnLabel": {
"example": false,
"type": "boolean"
},
"batchNumber": {
"example": "100301",
"type": "string"
},
"carrierCode": {
"example": "stamps_com",
"type": "string"
},
"serviceCode": {
"example": "usps_first_class_mail",
"type": "string"
},
"packageCode": {
"example": "package",
"type": "string"
},
"confirmation": {
"example": "delivery",
"type": "string"
},
"warehouseId": {
"example": 16079,
"type": "integer",
"format": "int32"
},
"voided": {
"example": false,
"type": "boolean"
},
"voidDate": {
"type": "string"
},
"marketplaceNotified": {
"example": true,
"type": "boolean"
},
"notifyErrorMessage": {
"type": "string"
},
"shipTo": {
"$ref": "#/definitions/ShipTo9"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"type": "string"
},
"insuranceOptions": {
"$ref": "#/definitions/InsuranceOptions4"
},
"advancedOptions": {
"type": "string"
},
"shipmentItems": {
"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
}
],
"type": "array",
"items": {
"$ref": "#/definitions/ShipmentItem"
}
},
"labelData": {
"type": "string"
},
"formData": {
"type": "string"
}
},
"required": [
"shipmentId",
"orderId",
"userId",
"orderNumber",
"createDate",
"shipDate",
"shipmentCost",
"insuranceCost",
"trackingNumber",
"isReturnLabel",
"batchNumber",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"warehouseId",
"voided",
"marketplaceNotified",
"shipTo",
"weight",
"insuranceOptions",
"shipmentItems"
]
},
"ShipTo9": {
"title": "ShipTo9",
"example": {
"name": "Yoda",
"company": "",
"street1": "12223 LOWDEN LN",
"street2": "",
"street3": null,
"city": "MANCHACA",
"state": "TX",
"postalCode": "78652-3602",
"country": "US",
"phone": "2101235544",
"residential": null
},
"type": "object",
"properties": {
"name": {
"example": "Yoda",
"type": "string"
},
"company": {
"type": "string"
},
"street1": {
"example": "12223 LOWDEN LN",
"type": "string"
},
"street2": {
"type": "string"
},
"street3": {
"type": "string"
},
"city": {
"example": "MANCHACA",
"type": "string"
},
"state": {
"example": "TX",
"type": "string"
},
"postalCode": {
"example": "78652-3602",
"type": "string"
},
"country": {
"example": "US",
"type": "string"
},
"phone": {
"example": "2101235544",
"type": "string"
},
"residential": {
"type": "string"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"phone"
]
},
"ShipmentItem": {
"title": "ShipmentItem",
"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
},
"type": "object",
"properties": {
"orderItemId": {
"example": 56568665,
"type": "integer",
"format": "int32"
},
"lineItemKey": {
"type": "string"
},
"sku": {
"example": "SQ3785739",
"type": "string"
},
"name": {
"example": "Potato Kitten -",
"type": "string"
},
"imageUrl": {
"type": "string"
},
"weight": {
"type": "string"
},
"quantity": {
"example": 1,
"type": "integer",
"format": "int32"
},
"unitPrice": {
"example": 1,
"type": "integer",
"format": "int32"
},
"warehouseLocation": {
"type": "string"
},
"options": {
"type": "string"
},
"productId": {
"example": 7565777,
"type": "integer",
"format": "int32"
},
"fulfillmentSku": {
"type": "string"
}
},
"required": [
"orderItemId",
"sku",
"name",
"quantity",
"unitPrice",
"productId"
]
},
"ListShipmentswithparametersresponse": {
"title": "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
},
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/definitions/Shipment"
}
},
"total": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
}
},
"required": [
"shipments",
"total",
"page",
"pages"
]
},
"CreateShipmentLabelrequest": {
"title": "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
},
"type": "object",
"properties": {
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"shipFrom": {
"$ref": "#/definitions/ShipFrom"
},
"shipTo": {
"$ref": "#/definitions/ShipTo11"
},
"insuranceOptions": {
"type": "string"
},
"internationalOptions": {
"type": "string"
},
"advancedOptions": {
"type": "string"
},
"testLabel": {
"type": "boolean"
}
},
"required": [
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"shipDate",
"weight",
"dimensions",
"shipFrom",
"shipTo",
"testLabel"
]
},
"ShipFrom": {
"title": "ShipFrom",
"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"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"residential"
]
},
"ShipTo11": {
"title": "ShipTo11",
"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"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"postalCode",
"country",
"residential"
]
},
"CreateShipmentLabelresponse": {
"title": "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
},
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32"
},
"orderId": {
"type": "string"
},
"userId": {
"type": "string"
},
"customerEmail": {
"type": "string"
},
"orderNumber": {
"type": "string"
},
"createDate": {
"type": "string"
},
"shipDate": {
"type": "string"
},
"shipmentCost": {
"type": "number",
"format": "double"
},
"insuranceCost": {
"type": "integer",
"format": "int32"
},
"trackingNumber": {
"type": "string"
},
"isReturnLabel": {
"type": "boolean"
},
"batchNumber": {
"type": "string"
},
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"confirmation": {
"type": "string"
},
"warehouseId": {
"type": "string"
},
"voided": {
"type": "boolean"
},
"voidDate": {
"type": "string"
},
"marketplaceNotified": {
"type": "boolean"
},
"notifyErrorMessage": {
"type": "string"
},
"shipTo": {
"type": "string"
},
"weight": {
"type": "string"
},
"dimensions": {
"type": "string"
},
"insuranceOptions": {
"type": "string"
},
"advancedOptions": {
"type": "string"
},
"shipmentItems": {
"type": "string"
},
"labelData": {
"type": "string"
},
"formData": {
"type": "string"
}
},
"required": [
"shipmentId",
"createDate",
"shipDate",
"shipmentCost",
"insuranceCost",
"trackingNumber",
"isReturnLabel",
"carrierCode",
"serviceCode",
"packageCode",
"confirmation",
"voided",
"marketplaceNotified",
"labelData"
]
},
"GetRatesrequest": {
"title": "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
},
"type": "object",
"properties": {
"carrierCode": {
"type": "string"
},
"serviceCode": {
"type": "string"
},
"packageCode": {
"type": "string"
},
"fromPostalCode": {
"type": "string"
},
"toState": {
"type": "string"
},
"toCountry": {
"type": "string"
},
"toPostalCode": {
"type": "string"
},
"toCity": {
"type": "string"
},
"weight": {
"$ref": "#/definitions/Weight"
},
"dimensions": {
"$ref": "#/definitions/Dimensions"
},
"confirmation": {
"type": "string"
},
"residential": {
"type": "boolean"
}
},
"required": [
"carrierCode",
"fromPostalCode",
"toState",
"toCountry",
"toPostalCode",
"toCity",
"weight",
"dimensions",
"confirmation",
"residential"
]
},
"GetRatesresponse": {
"title": "GetRatesresponse",
"example": {
"serviceName": "FedEx First Overnight®",
"serviceCode": "fedex_first_overnight",
"shipmentCost": 87.8,
"otherCost": 2.63
},
"type": "object",
"properties": {
"serviceName": {
"example": "FedEx First Overnight®",
"type": "string"
},
"serviceCode": {
"example": "fedex_first_overnight",
"type": "string"
},
"shipmentCost": {
"example": 87.8,
"type": "number",
"format": "double"
},
"otherCost": {
"example": 2.63,
"type": "number",
"format": "double"
}
},
"required": [
"serviceName",
"serviceCode",
"shipmentCost",
"otherCost"
]
},
"VoidLabelrequest": {
"title": "VoidLabelrequest",
"example": {
"shipmentId": 12345
},
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int32"
}
},
"required": [
"shipmentId"
]
},
"VoidLabelresponse": {
"title": "VoidLabelresponse",
"example": {
"approved": true,
"message": "Label voided successfully"
},
"type": "object",
"properties": {
"approved": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"approved",
"message"
]
},
"GetStoreresponse": {
"title": "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"
}
]
},
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"storeName": {
"type": "string"
},
"marketplaceId": {
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"type": "string"
},
"accountName": {
"type": "string"
},
"email": {
"type": "string"
},
"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": "#/definitions/StatusMapping"
}
}
},
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"integrationUrl",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh",
"statusMappings"
]
},
"StatusMapping": {
"title": "StatusMapping",
"type": "object",
"properties": {
"orderStatus": {
"example": "awaiting_payment",
"type": "string"
},
"statusKey": {
"example": "Pending",
"type": "string"
}
},
"required": [
"orderStatus",
"statusKey"
]
},
"UpdateStorerequest": {
"title": "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"
}
]
},
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"storeName": {
"type": "string"
},
"marketplaceId": {
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"type": "string"
},
"accountName": {
"type": "string"
},
"email": {
"type": "string"
},
"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": "#/definitions/StatusMapping"
}
}
},
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"integrationUrl",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh",
"statusMappings"
]
},
"UpdateStoreresponse": {
"title": "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"
}
]
},
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"storeName": {
"type": "string"
},
"marketplaceId": {
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"type": "string"
},
"accountName": {
"type": "string"
},
"email": {
"type": "string"
},
"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": "#/definitions/StatusMapping"
}
}
},
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"integrationUrl",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh",
"statusMappings"
]
},
"GetStoreRefreshStatusresponse": {
"title": "GetStoreRefreshStatusresponse",
"example": {
"storeId": 12345,
"refreshStatusId": 2,
"refreshStatus": "Updating orders",
"lastRefreshAttempt": "8-13-2014",
"refreshDate": "8-13-2014"
},
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"refreshStatusId": {
"type": "integer",
"format": "int32"
},
"refreshStatus": {
"type": "string"
},
"lastRefreshAttempt": {
"type": "string"
},
"refreshDate": {
"type": "string"
}
},
"required": [
"storeId",
"refreshStatusId",
"refreshStatus",
"lastRefreshAttempt",
"refreshDate"
]
},
"RefreshStorerequest": {
"title": "RefreshStorerequest",
"example": {
"storeId": 12345,
"refreshDate": "12-08-2014"
},
"type": "object",
"properties": {
"storeId": {
"type": "integer",
"format": "int32"
},
"refreshDate": {
"type": "string"
}
},
"required": [
"storeId",
"refreshDate"
]
},
"RefreshStoreresponse": {
"title": "RefreshStoreresponse",
"example": {
"success": true,
"message": "A store refresh has been initiated for Store ID 12345"
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"ListStoresresponse": {
"title": "ListStoresresponse",
"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
},
"type": "object",
"properties": {
"storeId": {
"example": 22766,
"type": "integer",
"format": "int32"
},
"storeName": {
"example": "ShipStation Manual Store",
"type": "string"
},
"marketplaceId": {
"example": 0,
"type": "integer",
"format": "int32"
},
"marketplaceName": {
"example": "ShipStation",
"type": "string"
},
"accountName": {
"type": "string"
},
"email": {
"type": "string"
},
"integrationUrl": {
"type": "string"
},
"active": {
"example": true,
"type": "boolean"
},
"companyName": {
"type": "string"
},
"phone": {
"type": "string"
},
"publicEmail": {
"example": "testemail@email.com",
"type": "string"
},
"website": {
"type": "string"
},
"refreshDate": {
"example": "12/3/2014 11:46:11 AM",
"type": "string"
},
"lastRefreshAttempt": {
"example": "12/3/2014 11:46:53 AM",
"type": "string"
},
"createDate": {
"example": "7/25/2014 11:05:55 AM",
"type": "string"
},
"modifyDate": {
"example": "11/12/2014 8:45:20 AM",
"type": "string"
},
"autoRefresh": {
"example": false,
"type": "boolean"
}
},
"required": [
"storeId",
"storeName",
"marketplaceId",
"marketplaceName",
"active",
"companyName",
"phone",
"publicEmail",
"website",
"refreshDate",
"lastRefreshAttempt",
"createDate",
"modifyDate",
"autoRefresh"
]
},
"ListMarketplacesresponse": {
"title": "ListMarketplacesresponse",
"example": {
"name": "3DCart",
"marketplaceId": 23,
"canRefresh": true,
"supportsCustomMappings": true,
"supportsCustomStatuses": false,
"canConfirmShipments": true
},
"type": "object",
"properties": {
"name": {
"example": "3DCart",
"type": "string"
},
"marketplaceId": {
"example": 23,
"type": "integer",
"format": "int32"
},
"canRefresh": {
"example": true,
"type": "boolean"
},
"supportsCustomMappings": {
"example": true,
"type": "boolean"
},
"supportsCustomStatuses": {
"example": false,
"type": "boolean"
},
"canConfirmShipments": {
"example": true,
"type": "boolean"
}
},
"required": [
"name",
"marketplaceId",
"canRefresh",
"supportsCustomMappings",
"supportsCustomStatuses",
"canConfirmShipments"
]
},
"DeactivateStorerequest": {
"title": "DeactivateStorerequest",
"example": {
"storeId": "12345"
},
"type": "object",
"properties": {
"storeId": {
"type": "string"
}
},
"required": [
"storeId"
]
},
"DeactivateStoreresponse": {
"title": "DeactivateStoreresponse",
"example": {
"success": "true",
"message": "The requested store has been reactivated."
},
"type": "object",
"properties": {
"success": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"ReactivateStorerequest": {
"title": "ReactivateStorerequest",
"example": {
"storeId": "12345"
},
"type": "object",
"properties": {
"storeId": {
"type": "string"
}
},
"required": [
"storeId"
]
},
"ReactivateStoreresponse": {
"title": "ReactivateStoreresponse",
"example": {
"success": "true",
"message": "The requested store has been reactivated."
},
"type": "object",
"properties": {
"success": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"ListUsersresponse": {
"title": "ListUsersresponse",
"example": {
"userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
"userName": "SS-user1",
"name": "Shipping Employee 1"
},
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"userName": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"userId",
"userName",
"name"
]
},
"GetWarehouseresponse": {
"title": "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
},
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/definitions/OriginAddress"
},
"returnAddress": {
"$ref": "#/definitions/ReturnAddress"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
]
},
"OriginAddress": {
"title": "OriginAddress",
"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"
},
"addressVerified": {
"type": "string"
}
},
"required": [
"name",
"company",
"street1",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
]
},
"ReturnAddress": {
"title": "ReturnAddress",
"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"
},
"addressVerified": {
"type": "string"
}
},
"required": [
"name",
"company",
"street1",
"city",
"state",
"postalCode",
"country",
"phone"
]
},
"UpdateWarehouserequest": {
"title": "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.487",
"isDefault": true
},
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/definitions/OriginAddress"
},
"returnAddress": {
"$ref": "#/definitions/ReturnAddress"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
]
},
"UpdateWarehouseresponse": {
"title": "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
},
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/definitions/OriginAddress"
},
"returnAddress": {
"$ref": "#/definitions/ReturnAddress"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
]
},
"DeleteWarehouseresponse": {
"title": "DeleteWarehouseresponse",
"example": {
"success": true,
"message": "The requested warehouse has been deleted."
},
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"required": [
"success",
"message"
]
},
"CreateWarehouserequest": {
"title": "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
},
"type": "object",
"properties": {
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/definitions/OriginAddress3"
},
"returnAddress": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"warehouseName",
"originAddress",
"isDefault"
]
},
"OriginAddress3": {
"title": "OriginAddress3",
"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"
}
},
"required": [
"name",
"company",
"street1",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
]
},
"CreateWarehouseresponse": {
"title": "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
},
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int32"
},
"warehouseName": {
"type": "string"
},
"originAddress": {
"$ref": "#/definitions/OriginAddress4"
},
"returnAddress": {
"$ref": "#/definitions/ReturnAddress3"
},
"createDate": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
]
},
"OriginAddress4": {
"title": "OriginAddress4",
"example": {
"name": "Spring warehouse",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": false
},
"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"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"street3",
"city",
"state",
"postalCode",
"country",
"phone",
"residential"
]
},
"ReturnAddress3": {
"title": "ReturnAddress3",
"example": {
"name": "Chicago House",
"company": "",
"street1": "123 S SPRING RD ",
"street2": "",
"street3": "",
"city": "Elmurst",
"state": "IL",
"postalCode": "60126",
"country": "US",
"phone": "5121112222",
"residential": null
},
"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"
}
},
"required": [
"name",
"company",
"street1",
"street2",
"street3",
"city",
"state",
"postalCode",
"country",
"phone"
]
},
"ListWarehousesresponse": {
"title": "ListWarehousesresponse",
"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
},
"type": "object",
"properties": {
"warehouseId": {
"example": 17977,
"type": "integer",
"format": "int32"
},
"warehouseName": {
"example": "Main warehouse",
"type": "string"
},
"originAddress": {
"$ref": "#/definitions/OriginAddress4"
},
"returnAddress": {
"$ref": "#/definitions/ReturnAddress3"
},
"createDate": {
"example": "10/21/2014 8:11:43 AM",
"type": "string"
},
"isDefault": {
"example": true,
"type": "boolean"
}
},
"required": [
"warehouseId",
"warehouseName",
"originAddress",
"returnAddress",
"createDate",
"isDefault"
]
},
"ListWebhooksresponse": {
"title": "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
}
]
},
"type": "object",
"properties": {
"webhooks": {
"type": "array",
"items": {
"$ref": "#/definitions/Webhook"
}
}
},
"required": [
"webhooks"
]
},
"Webhook": {
"title": "Webhook",
"type": "object",
"properties": {
"IsLabelAPIHook": {
"example": false,
"type": "boolean"
},
"WebHookID": {
"example": 123,
"type": "integer",
"format": "int32"
},
"SellerID": {
"example": 100000,
"type": "integer",
"format": "int32"
},
"StoreID": {
"example": 12345,
"type": "integer",
"format": "int32"
},
"HookType": {
"example": "ITEM_ORDER_NOTIFY",
"type": "string"
},
"MessageFormat": {
"example": "Json",
"type": "string"
},
"Url": {
"example": "http://example.endpoint/orders",
"type": "string"
},
"Name": {
"example": "My Order Webhook",
"type": "string"
},
"BulkCopyBatchID": {
"type": "string"
},
"BulkCopyRecordID": {
"type": "string"
},
"Active": {
"example": true,
"type": "boolean"
},
"WebhookLogs": {
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"Seller": {
"type": "string"
},
"Store": {
"type": "string"
}
},
"required": [
"IsLabelAPIHook",
"WebHookID",
"SellerID",
"StoreID",
"HookType",
"MessageFormat",
"Url",
"Name",
"Active",
"WebhookLogs"
]
},
"SubscribetoWebhookrequest": {
"title": "SubscribetoWebhookrequest",
"example": {
"target_url": "http://someexamplewebhookurl.com/neworder",
"event": "ORDER_NOTIFY",
"store_id": null,
"friendly_name": "My Webhook"
},
"type": "object",
"properties": {
"target_url": {
"type": "string"
},
"event": {
"type": "string"
},
"store_id": {
"type": "string"
},
"friendly_name": {
"type": "string"
}
},
"required": [
"target_url",
"event",
"friendly_name"
]
},
"SubscribetoWebhookresponse": {
"title": "SubscribetoWebhookresponse",
"example": {
"id": 123456
},
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
},
"required": [
"id"
]
}
},
"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": ""
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment