-
Notifications
You must be signed in to change notification settings - Fork 0
/
nswag.nswag
101 lines (101 loc) · 501 KB
/
nswag.nswag
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
{
"runtime": "Net80",
"defaultVariables": null,
"documentGenerator": {
"fromDocument": {
"json": "openapi: 3.1.0\r\ninfo:\r\n title: ShipStation API\r\n description: >+\r\n This collection contains basic functionality of ShipStation. Including create order, create labels for an order, add products to an order, and manage stores etc.\r\n\r\n\r\n\r\n ## Authentication\r\n\r\n\r\n\r\n The ShipStation API uses Basic HTTP 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 .\r\n\r\n\r\n\r\n Pass `API KEY` as username and `API Secret` as password in this collection.\r\n\r\n contact: {}\r\n version: 'v2'\r\njsonSchemaDialect: https://json-schema.org/draft/2020-12/schema\r\nservers:\r\n- url: https://ssapi.shipstation.com\r\n variables: {}\r\npaths:\r\n //carriers/addfunds:\r\n post:\r\n tags:\r\n - Carriers\r\n summary: Add funds to carrier account\r\n description: \"Adds funds to a carrier account using the payment information on file. <br> \\r\\nRequires approval from apisupport@shipstation.com before use.\"\r\n operationId: Addfundstocarrieraccount\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/AddfundstocarrieraccountRequest'\r\n - examples:\r\n - carrierCode: fedex\r\n amount: 20\r\n contentMediaType: application/json\r\n example:\r\n carrierCode: fedex\r\n amount: 20\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //carriers/getcarrier:\r\n get:\r\n tags:\r\n - Carriers\r\n summary: Get Carrier By Code\r\n description: Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.\r\n operationId: GetCarrierByCode\r\n parameters:\r\n - name: carrierCode\r\n in: query\r\n description: The code for the carrier account to retrieve.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - '{{carrierCode}}'\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 00:47:46 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GCIHEUpaVRYSTXBUQyUFQ0RaBxRBTgBMCE4IFgQBB1QNUQhNHlNIFFQHBAINBgEGAFIHBgcHUVAUHwQHDxFVPw==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '14'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '166'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetCarrierByCode'\r\n - examples:\r\n - name: Stamps.com\r\n code: stamps_com\r\n accountNumber: null\r\n requiresFundedAccount: true\r\n balance: 0\r\n nickname: Free\r\n shippingProviderId: 150759\r\n primary: true\r\n contentMediaType: application/json\r\n example:\r\n name: Stamps.com\r\n code: stamps_com\r\n accountNumber: null\r\n requiresFundedAccount: true\r\n balance: 0\r\n nickname: Free\r\n shippingProviderId: 150759\r\n primary: true\r\n deprecated: false\r\n parameters: []\r\n //carriers:\r\n get:\r\n tags:\r\n - Carriers\r\n summary: List Carriers\r\n description: List all shipping providers connected to this account.\r\n operationId: ListCarriers\r\n parameters: []\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 14:03:17 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GCIHEUpaVRYSTXtYRBJGHQYdUkpTTABRDFsOCgweHlQVQ1QFAQdTUwZSUFBcClJdWFAVHVEHCEJTbg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '42'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '168'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListCarrier'\r\n description: ''\r\n examples:\r\n - - name: Stamps.com\r\n code: stamps_com\r\n accountNumber: null\r\n requiresFundedAccount: true\r\n balance: 0\r\n nickname: Free\r\n shippingProviderId: 150759\r\n primary: true\r\n contentMediaType: application/json\r\n example:\r\n - name: Stamps.com\r\n code: stamps_com\r\n accountNumber: null\r\n requiresFundedAccount: true\r\n balance: 0\r\n nickname: Free\r\n shippingProviderId: 150759\r\n primary: true\r\n deprecated: false\r\n parameters: []\r\n //carriers/listpackages:\r\n get:\r\n tags:\r\n - Carriers\r\n summary: List Packages\r\n description: Retrieves a list of packages for the specified carrier.\r\n operationId: ListPackages\r\n parameters:\r\n - name: carrierCode\r\n in: query\r\n description: The carrier's code\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - '{{carrierCode}}'\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 14:05:53 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GCIHEUpaVRYSTXtYRBI0UFVYAwEGERJOCEwIFAQcAlUMUQVUAk5JBxtDVFJeBVJQUVJUBQ9VAAdXUkBKBQNcEV0/\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '7'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '1589'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListPackage'\r\n description: ''\r\n examples:\r\n - - carrierCode: stamps_com\r\n code: package\r\n name: Package\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: flat_rate_envelope\r\n name: Flat Rate Envelope\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: flat_rate_legal_envelope\r\n name: Flat Rate Legal Envelope\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: flat_rate_padded_envelope\r\n name: Flat Rate Padded Envelope\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: large_envelope_or_flat\r\n name: Large Envelope or Flat\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: large_flat_rate_box\r\n name: Large Flat Rate Box\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: large_package\r\n name: Large Package (any side > 12\")\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: letter\r\n name: Letter\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: medium_flat_rate_box\r\n name: Medium Flat Rate Box\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: regional_rate_box_a\r\n name: Regional Rate Box A\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: regional_rate_box_b\r\n name: Regional Rate Box B\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: small_flat_rate_box\r\n name: Small Flat Rate Box\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: thick_envelope\r\n name: Thick Envelope\r\n domestic: true\r\n international: true\r\n contentMediaType: application/json\r\n example:\r\n - carrierCode: stamps_com\r\n code: package\r\n name: Package\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: flat_rate_envelope\r\n name: Flat Rate Envelope\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: flat_rate_legal_envelope\r\n name: Flat Rate Legal Envelope\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: flat_rate_padded_envelope\r\n name: Flat Rate Padded Envelope\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: large_envelope_or_flat\r\n name: Large Envelope or Flat\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: large_flat_rate_box\r\n name: Large Flat Rate Box\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: large_package\r\n name: Large Package (any side > 12\")\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: letter\r\n name: Letter\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: medium_flat_rate_box\r\n name: Medium Flat Rate Box\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: regional_rate_box_a\r\n name: Regional Rate Box A\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: regional_rate_box_b\r\n name: Regional Rate Box B\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: small_flat_rate_box\r\n name: Small Flat Rate Box\r\n domestic: true\r\n international: true\r\n - carrierCode: stamps_com\r\n code: thick_envelope\r\n name: Thick Envelope\r\n domestic: true\r\n international: true\r\n deprecated: false\r\n parameters: []\r\n //carriers/listservices:\r\n get:\r\n tags:\r\n - Carriers\r\n summary: List Services\r\n description: Retrieves the list of available shipping services provided by the specified carrier.\r\n operationId: ListServices\r\n parameters:\r\n - name: carrierCode\r\n in: query\r\n description: The carrier's code\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - '{{carrierCode}}'\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 14:08:29 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GCIHEUpaVRYSTXtYRBI3VERFCwUGERJOCEwIFAQcA1QBWQNUB05JBxtDBwIAUQdUU1ZUBQ8HAghVUUBKBQNcEV0/\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '30'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '1087'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListService'\r\n description: ''\r\n examples:\r\n - - carrierCode: stamps_com\r\n code: usps_first_class_mail\r\n name: USPS First Class Mail\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_media_mail\r\n name: USPS Media Mail\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_parcel_select\r\n name: USPS Parcel Select Ground\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail\r\n name: USPS Priority Mail\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail_express\r\n name: USPS Priority Mail Express\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_first_class_mail_international\r\n name: USPS First Class Mail Intl\r\n domestic: false\r\n international: true\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail_international\r\n name: USPS Priority Mail Intl\r\n domestic: false\r\n international: true\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail_express_international\r\n name: USPS Priority Mail Express Intl\r\n domestic: false\r\n international: true\r\n contentMediaType: application/json\r\n example:\r\n - carrierCode: stamps_com\r\n code: usps_first_class_mail\r\n name: USPS First Class Mail\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_media_mail\r\n name: USPS Media Mail\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_parcel_select\r\n name: USPS Parcel Select Ground\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail\r\n name: USPS Priority Mail\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail_express\r\n name: USPS Priority Mail Express\r\n domestic: true\r\n international: false\r\n - carrierCode: stamps_com\r\n code: usps_first_class_mail_international\r\n name: USPS First Class Mail Intl\r\n domestic: false\r\n international: true\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail_international\r\n name: USPS Priority Mail Intl\r\n domestic: false\r\n international: true\r\n - carrierCode: stamps_com\r\n code: usps_priority_mail_express_international\r\n name: USPS Priority Mail Express Intl\r\n domestic: false\r\n international: true\r\n deprecated: false\r\n parameters: []\r\n //customers:\r\n get:\r\n tags:\r\n - Customers\r\n summary: List Customers\r\n description: Obtains a list of customers that match the specified criteria.\r\n operationId: ListCustomers\r\n parameters:\r\n - name: stateCode\r\n in: query\r\n description: Returns customers that reside in the specified stateCode.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: countryCode\r\n in: query\r\n description: Returns customers that reside in the specified countryCode.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: tagId\r\n in: query\r\n description: Returns customers that purchased items from the specified marketplaceId.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortBy\r\n in: query\r\n description: Sorts the order of the response based off the specified value.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortDir\r\n in: query\r\n description: Sets the direction of the sort order.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: page\r\n in: query\r\n description: Page number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: pageSize\r\n in: query\r\n description: Requested page size. Max value is 500.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 14:40:25 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GCITEExcXQETERh9XhUQExoDTFZPUh5SC1sKCgIAH0gITRMFUVBXBw8CBVsKBAIFUVACExsABV1FVj8=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '38'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '35'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '1233'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/ListCustomers'\r\n - examples:\r\n - customers:\r\n - customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n - customerId: 12923112\r\n createDate: 2021-01-23T06:40:15.0170000\r\n modifyDate: 2021-01-23T06:40:15.0170000\r\n name: John Peters\r\n company: Sample Company\r\n street1: 123 Street\r\n street2: ''\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n countryCode: US\r\n phone: (512) 555-5555\r\n email: john@samplecompany.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744167\r\n customerId: 12923112\r\n createDate: 2021-01-23T06:40:15.0170000\r\n modifyDate: 2021-01-23T06:40:15.0170000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: john.peters\r\n tags: null\r\n total: 2\r\n page: 1\r\n pages: 1\r\n contentMediaType: application/json\r\n example:\r\n customers:\r\n - customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n - customerId: 12923112\r\n createDate: 2021-01-23T06:40:15.0170000\r\n modifyDate: 2021-01-23T06:40:15.0170000\r\n name: John Peters\r\n company: Sample Company\r\n street1: 123 Street\r\n street2: ''\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n countryCode: US\r\n phone: (512) 555-5555\r\n email: john@samplecompany.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744167\r\n customerId: 12923112\r\n createDate: 2021-01-23T06:40:15.0170000\r\n modifyDate: 2021-01-23T06:40:15.0170000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: john.peters\r\n tags: null\r\n total: 2\r\n page: 1\r\n pages: 1\r\n deprecated: false\r\n parameters: []\r\n //customers/{customerId}:\r\n get:\r\n tags:\r\n - Customers\r\n summary: Get Customer\r\n description: Get Customer with specific Id.\r\n operationId: GetCustomer\r\n parameters:\r\n - name: customerId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 15:39:53 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GCITEExcXQETERh2UhJGHQYdUkpTTAJTClEKDwweHlQVQ1JWVQcBAQBYUgJeVVUFVFMVHVEHCEJTbg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '7'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '592'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetCustomer'\r\n - examples:\r\n - customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n contentMediaType: application/json\r\n example:\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n deprecated: false\r\n parameters: []\r\n //fulfillments:\r\n get:\r\n tags:\r\n - Fulfillments\r\n summary: List Fulfillments\r\n operationId: ListFulfillments\r\n parameters:\r\n - name: fulfillmentId\r\n in: query\r\n description: Returns the fulfillment with the specified fulfillment ID.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderId\r\n in: query\r\n description: Returns fulfillments whose orders have the specified order ID.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderNumber\r\n in: query\r\n description: Returns fulfillments whose orders have the specified order number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: trackingNumber\r\n in: query\r\n description: Returns fulfillments with the specified tracking number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: recipientName\r\n in: query\r\n description: Returns fulfillments shipped to the specified recipient name.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: createDateStart\r\n in: query\r\n description: Returns fulfillments created on or after the specified createDate.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: createDateEnd\r\n in: query\r\n description: Returns fulfillments created on or before the specified createDate.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: shipDateStart\r\n in: query\r\n description: Returns fulfillments with the shipDate on or after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: shipDateEnd\r\n in: query\r\n description: Returns fulfillments with the shipDate on or before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortBy\r\n in: query\r\n 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.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortDir\r\n in: query\r\n description: Sets the direction of the sort order.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: page\r\n in: query\r\n description: Page number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: pageSize\r\n in: query\r\n description: Page size.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: Authorization\r\n in: header\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n examples:\r\n - '{{authToken}}'\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n security: []\r\n parameters: []\r\n //orders/createorder:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Create/Update Order\r\n description: >-\r\n If the `orderKey` is specified, the method becomes idempotent and the existing order with that key will be updated. This call does not currently support partial updates; the entire resource must be provided in the body of the request. <br> <br>\r\n\r\n\r\n\r\n 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` object:\r\n operationId: Create/UpdateOrder\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n\r\n \"orderNumber\": \"TEST-ORDER-API-DOCS\",\r\n\r\n \"orderKey\": \"{{$guid}}\",\r\n\r\n \"orderDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"paymentDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"shipByDate\": \"2015-07-05T00:00:00.0000000\",\r\n\r\n \"orderStatus\": \"awaiting_shipment\",\r\n\r\n \"customerId\": {{customerId}},\r\n\r\n \"customerUsername\": \"john.smith@gmail.com\",\r\n\r\n \"customerEmail\": \"john.smith@gmail.com\",\r\n\r\n \"billTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": null,\r\n\r\n \"street1\": null,\r\n\r\n \"street2\": null,\r\n\r\n \"street3\": null,\r\n\r\n \"city\": null,\r\n\r\n \"state\": null,\r\n\r\n \"postalCode\": null,\r\n\r\n \"country\": null,\r\n\r\n \"phone\": null,\r\n\r\n \"residential\": null\r\n\r\n },\r\n\r\n \"shipTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": \"US Govt\",\r\n\r\n \"street1\": \"1600 Pennsylvania Ave\",\r\n\r\n \"street2\": \"Oval Office\",\r\n\r\n \"street3\": null,\r\n\r\n \"city\": \"Washington\",\r\n\r\n \"state\": \"DC\",\r\n\r\n \"postalCode\": \"20500\",\r\n\r\n \"country\": \"US\",\r\n\r\n \"phone\": \"555-555-5555\",\r\n\r\n \"residential\": true\r\n\r\n },\r\n\r\n \"items\": [\r\n\r\n {\r\n\r\n \"lineItemKey\": \"vd08-MSLbtx\",\r\n\r\n \"sku\": \"ABC123\",\r\n\r\n \"name\": \"Test item #1\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 24,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 2,\r\n\r\n \"unitPrice\": 99.99,\r\n\r\n \"taxAmount\": 2.5,\r\n\r\n \"shippingAmount\": 5,\r\n\r\n \"warehouseLocation\": \"Aisle 1, Bin 7\",\r\n\r\n \"options\": [\r\n\r\n {\r\n\r\n \"name\": \"Size\",\r\n\r\n \"value\": \"Large\"\r\n\r\n }\r\n\r\n ],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": null,\r\n\r\n \"adjustment\": false,\r\n\r\n \"upc\": \"32-65-98\"\r\n\r\n },\r\n\r\n {\r\n\r\n \"lineItemKey\": null,\r\n\r\n \"sku\": \"DISCOUNT CODE\",\r\n\r\n \"name\": \"10% OFF\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 0,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 1,\r\n\r\n \"unitPrice\": -20.55,\r\n\r\n \"taxAmount\": null,\r\n\r\n \"shippingAmount\": null,\r\n\r\n \"warehouseLocation\": null,\r\n\r\n \"options\": [],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": \"SKU-Discount\",\r\n\r\n \"adjustment\": true,\r\n\r\n \"upc\": null\r\n\r\n }\r\n\r\n ],\r\n\r\n \"amountPaid\": 218.73,\r\n\r\n \"taxAmount\": 5,\r\n\r\n \"shippingAmount\": 10,\r\n\r\n \"customerNotes\": \"Please ship as soon as possible!\",\r\n\r\n \"internalNotes\": \"Customer called and would like to upgrade shipping\",\r\n\r\n \"gift\": true,\r\n\r\n \"giftMessage\": \"Thank you!\",\r\n\r\n \"paymentMethod\": \"Credit Card\",\r\n\r\n \"requestedShippingService\": \"Priority Mail\",\r\n\r\n \"carrierCode\": \"fedex\",\r\n\r\n \"serviceCode\": \"fedex_2day\",\r\n\r\n \"packageCode\": \"package\",\r\n\r\n \"confirmation\": \"delivery\",\r\n\r\n \"shipDate\": \"2015-07-02\",\r\n\r\n \"weight\": {\r\n\r\n \"value\": 25,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"dimensions\": {\r\n\r\n \"units\": \"inches\",\r\n\r\n \"length\": 7,\r\n\r\n \"width\": 5,\r\n\r\n \"height\": 6\r\n\r\n },\r\n\r\n \"insuranceOptions\": {\r\n\r\n \"provider\": \"carrier\",\r\n\r\n \"insureShipment\": true,\r\n\r\n \"insuredValue\": 200\r\n\r\n },\r\n\r\n \"internationalOptions\": {\r\n\r\n \"contents\": null,\r\n\r\n \"customsItems\": null\r\n\r\n },\r\n\r\n \"advancedOptions\": {\r\n\r\n \"warehouseId\": 0,\r\n\r\n \"nonMachinable\": false,\r\n\r\n \"saturdayDelivery\": false,\r\n\r\n \"containsAlcohol\": false,\r\n\r\n \"mergedOrSplit\": false,\r\n\r\n \"mergedIds\": [],\r\n\r\n \"parentId\": null,\r\n\r\n \"storeId\": 179188,\r\n\r\n \"customField1\": \"Custom data that you can add to an order. See Custom Field #2 & #3 for more info!\",\r\n\r\n \"customField2\": \"Per UI settings, this information can appear on some carrier's shipping labels. See link below\",\r\n\r\n \"customField3\": \"https://help.shipstation.com/hc/en-us/articles/206639957\",\r\n\r\n \"source\": \"Webstore\",\r\n\r\n \"billToParty\": null,\r\n\r\n \"billToAccount\": null,\r\n\r\n \"billToPostalCode\": null,\r\n\r\n \"billToCountryCode\": null\r\n\r\n },\r\n\r\n \"tagIds\": [\r\n\r\n 53974\r\n\r\n ]\r\n\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n\r\n \"orderNumber\": \"TEST-ORDER-API-DOCS\",\r\n\r\n \"orderKey\": \"{{$guid}}\",\r\n\r\n \"orderDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"paymentDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"shipByDate\": \"2015-07-05T00:00:00.0000000\",\r\n\r\n \"orderStatus\": \"awaiting_shipment\",\r\n\r\n \"customerId\": {{customerId}},\r\n\r\n \"customerUsername\": \"john.smith@gmail.com\",\r\n\r\n \"customerEmail\": \"john.smith@gmail.com\",\r\n\r\n \"billTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": null,\r\n\r\n \"street1\": null,\r\n\r\n \"street2\": null,\r\n\r\n \"street3\": null,\r\n\r\n \"city\": null,\r\n\r\n \"state\": null,\r\n\r\n \"postalCode\": null,\r\n\r\n \"country\": null,\r\n\r\n \"phone\": null,\r\n\r\n \"residential\": null\r\n\r\n },\r\n\r\n \"shipTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": \"US Govt\",\r\n\r\n \"street1\": \"1600 Pennsylvania Ave\",\r\n\r\n \"street2\": \"Oval Office\",\r\n\r\n \"street3\": null,\r\n\r\n \"city\": \"Washington\",\r\n\r\n \"state\": \"DC\",\r\n\r\n \"postalCode\": \"20500\",\r\n\r\n \"country\": \"US\",\r\n\r\n \"phone\": \"555-555-5555\",\r\n\r\n \"residential\": true\r\n\r\n },\r\n\r\n \"items\": [\r\n\r\n {\r\n\r\n \"lineItemKey\": \"vd08-MSLbtx\",\r\n\r\n \"sku\": \"ABC123\",\r\n\r\n \"name\": \"Test item #1\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 24,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 2,\r\n\r\n \"unitPrice\": 99.99,\r\n\r\n \"taxAmount\": 2.5,\r\n\r\n \"shippingAmount\": 5,\r\n\r\n \"warehouseLocation\": \"Aisle 1, Bin 7\",\r\n\r\n \"options\": [\r\n\r\n {\r\n\r\n \"name\": \"Size\",\r\n\r\n \"value\": \"Large\"\r\n\r\n }\r\n\r\n ],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": null,\r\n\r\n \"adjustment\": false,\r\n\r\n \"upc\": \"32-65-98\"\r\n\r\n },\r\n\r\n {\r\n\r\n \"lineItemKey\": null,\r\n\r\n \"sku\": \"DISCOUNT CODE\",\r\n\r\n \"name\": \"10% OFF\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 0,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 1,\r\n\r\n \"unitPrice\": -20.55,\r\n\r\n \"taxAmount\": null,\r\n\r\n \"shippingAmount\": null,\r\n\r\n \"warehouseLocation\": null,\r\n\r\n \"options\": [],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": \"SKU-Discount\",\r\n\r\n \"adjustment\": true,\r\n\r\n \"upc\": null\r\n\r\n }\r\n\r\n ],\r\n\r\n \"amountPaid\": 218.73,\r\n\r\n \"taxAmount\": 5,\r\n\r\n \"shippingAmount\": 10,\r\n\r\n \"customerNotes\": \"Please ship as soon as possible!\",\r\n\r\n \"internalNotes\": \"Customer called and would like to upgrade shipping\",\r\n\r\n \"gift\": true,\r\n\r\n \"giftMessage\": \"Thank you!\",\r\n\r\n \"paymentMethod\": \"Credit Card\",\r\n\r\n \"requestedShippingService\": \"Priority Mail\",\r\n\r\n \"carrierCode\": \"fedex\",\r\n\r\n \"serviceCode\": \"fedex_2day\",\r\n\r\n \"packageCode\": \"package\",\r\n\r\n \"confirmation\": \"delivery\",\r\n\r\n \"shipDate\": \"2015-07-02\",\r\n\r\n \"weight\": {\r\n\r\n \"value\": 25,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"dimensions\": {\r\n\r\n \"units\": \"inches\",\r\n\r\n \"length\": 7,\r\n\r\n \"width\": 5,\r\n\r\n \"height\": 6\r\n\r\n },\r\n\r\n \"insuranceOptions\": {\r\n\r\n \"provider\": \"carrier\",\r\n\r\n \"insureShipment\": true,\r\n\r\n \"insuredValue\": 200\r\n\r\n },\r\n\r\n \"internationalOptions\": {\r\n\r\n \"contents\": null,\r\n\r\n \"customsItems\": null\r\n\r\n },\r\n\r\n \"advancedOptions\": {\r\n\r\n \"warehouseId\": 0,\r\n\r\n \"nonMachinable\": false,\r\n\r\n \"saturdayDelivery\": false,\r\n\r\n \"containsAlcohol\": false,\r\n\r\n \"mergedOrSplit\": false,\r\n\r\n \"mergedIds\": [],\r\n\r\n \"parentId\": null,\r\n\r\n \"storeId\": 179188,\r\n\r\n \"customField1\": \"Custom data that you can add to an order. See Custom Field #2 & #3 for more info!\",\r\n\r\n \"customField2\": \"Per UI settings, this information can appear on some carrier's shipping labels. See link below\",\r\n\r\n \"customField3\": \"https://help.shipstation.com/hc/en-us/articles/206639957\",\r\n\r\n \"source\": \"Webstore\",\r\n\r\n \"billToParty\": null,\r\n\r\n \"billToAccount\": null,\r\n\r\n \"billToPostalCode\": null,\r\n\r\n \"billToCountryCode\": null\r\n\r\n },\r\n\r\n \"tagIds\": [\r\n\r\n 53974\r\n\r\n ]\r\n\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 17:19:48 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0siEFJQQwMrQ1JWEERPUh5SFFIWDAQHClQNWR1SBVFVGhVSX1MLAlVdB1JSVQdUVlRVEU4AAg5DB2U=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '38'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '12'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '3320'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/CreateUpdateOrder'\r\n - examples:\r\n - orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T09:09:08.4000000\r\n modifyDate: 2021-01-23T09:19:48.6130000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12934379\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32208850\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n - orderItemId: 32208851\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: delivery\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 25\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: null\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n contentMediaType: application/json\r\n example:\r\n orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T09:09:08.4000000\r\n modifyDate: 2021-01-23T09:19:48.6130000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12934379\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32208850\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n - orderItemId: 32208851\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: delivery\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 25\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: null\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n deprecated: false\r\n parameters: []\r\n //orders/createorders:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Create/Update Multiple Orders\r\n description: >-\r\n 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. This call does not currently support partial updates; the entire resource must be provided in the body of the request. <br/><br/>\r\n\r\n\r\n\r\n **NOTE:** You can only use this method to update orders in an open status in ShipStation (`awaiting_payment`,`awaiting_shipment`, and `on_hold`). Orders in cancelled and shipped statuse are locked from modification through the API.\r\n operationId: Create/UpdateMultipleOrders\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n [\r\n\r\n {\r\n\r\n \"orderNumber\": \"TEST-ORDER-API-DOCS\",\r\n\r\n \"orderKey\": \"{{$guid}}\",\r\n\r\n \"orderDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"paymentDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"shipByDate\": \"2015-07-05T00:00:00.0000000\",\r\n\r\n \"orderStatus\": \"awaiting_shipment\",\r\n\r\n \"customerId\": {{customerId}},\r\n\r\n \"customerUsername\": \"john.smith@gmail.com\",\r\n\r\n \"customerEmail\": \"john.smith@gmail.com\",\r\n\r\n \"billTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": null,\r\n\r\n \"street1\": null,\r\n\r\n \"street2\": null,\r\n\r\n \"street3\": null,\r\n\r\n \"city\": null,\r\n\r\n \"state\": null,\r\n\r\n \"postalCode\": null,\r\n\r\n \"country\": null,\r\n\r\n \"phone\": null,\r\n\r\n \"residential\": null\r\n\r\n },\r\n\r\n \"shipTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": \"US Govt\",\r\n\r\n \"street1\": \"1600 Pennsylvania Ave\",\r\n\r\n \"street2\": \"Oval Office\",\r\n\r\n \"street3\": null,\r\n\r\n \"city\": \"Washington\",\r\n\r\n \"state\": \"DC\",\r\n\r\n \"postalCode\": \"20500\",\r\n\r\n \"country\": \"US\",\r\n\r\n \"phone\": \"555-555-5555\",\r\n\r\n \"residential\": true\r\n\r\n },\r\n\r\n \"items\": [\r\n\r\n {\r\n\r\n \"lineItemKey\": \"vd08-MSLbtx\",\r\n\r\n \"sku\": \"ABC123\",\r\n\r\n \"name\": \"Test item #1\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 24,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 2,\r\n\r\n \"unitPrice\": 99.99,\r\n\r\n \"taxAmount\": 2.5,\r\n\r\n \"shippingAmount\": 5,\r\n\r\n \"warehouseLocation\": \"Aisle 1, Bin 7\",\r\n\r\n \"options\": [\r\n\r\n {\r\n\r\n \"name\": \"Size\",\r\n\r\n \"value\": \"Large\"\r\n\r\n }\r\n\r\n ],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": null,\r\n\r\n \"adjustment\": false,\r\n\r\n \"upc\": \"32-65-98\"\r\n\r\n },\r\n\r\n {\r\n\r\n \"lineItemKey\": null,\r\n\r\n \"sku\": \"DISCOUNT CODE\",\r\n\r\n \"name\": \"10% OFF\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 0,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 1,\r\n\r\n \"unitPrice\": -20.55,\r\n\r\n \"taxAmount\": null,\r\n\r\n \"shippingAmount\": null,\r\n\r\n \"warehouseLocation\": null,\r\n\r\n \"options\": [],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": \"SKU-Discount\",\r\n\r\n \"adjustment\": true,\r\n\r\n \"upc\": null\r\n\r\n }\r\n\r\n ],\r\n\r\n \"amountPaid\": 218.73,\r\n\r\n \"taxAmount\": 5,\r\n\r\n \"shippingAmount\": 10,\r\n\r\n \"customerNotes\": \"Please ship as soon as possible!\",\r\n\r\n \"internalNotes\": \"Customer called and would like to upgrade shipping\",\r\n\r\n \"gift\": true,\r\n\r\n \"giftMessage\": \"Thank you!\",\r\n\r\n \"paymentMethod\": \"Credit Card\",\r\n\r\n \"requestedShippingService\": \"Priority Mail\",\r\n\r\n \"carrierCode\": \"fedex\",\r\n\r\n \"serviceCode\": \"fedex_2day\",\r\n\r\n \"packageCode\": \"package\",\r\n\r\n \"confirmation\": \"delivery\",\r\n\r\n \"shipDate\": \"2015-07-02\",\r\n\r\n \"weight\": {\r\n\r\n \"value\": 25,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"dimensions\": {\r\n\r\n \"units\": \"inches\",\r\n\r\n \"length\": 7,\r\n\r\n \"width\": 5,\r\n\r\n \"height\": 6\r\n\r\n },\r\n\r\n \"insuranceOptions\": {\r\n\r\n \"provider\": \"carrier\",\r\n\r\n \"insureShipment\": true,\r\n\r\n \"insuredValue\": 200\r\n\r\n },\r\n\r\n \"internationalOptions\": {\r\n\r\n \"contents\": null,\r\n\r\n \"customsItems\": null\r\n\r\n },\r\n\r\n \"advancedOptions\": {\r\n\r\n \"warehouseId\": 0,\r\n\r\n \"nonMachinable\": false,\r\n\r\n \"saturdayDelivery\": false,\r\n\r\n \"containsAlcohol\": false,\r\n\r\n \"mergedOrSplit\": false,\r\n\r\n \"mergedIds\": [],\r\n\r\n \"parentId\": null,\r\n\r\n \"storeId\": 179188,\r\n\r\n \"customField1\": \"Custom data that you can add to an order. See Custom Field #2 & #3 for more info!\",\r\n\r\n \"customField2\": \"Per UI settings, this information can appear on some carrier's shipping labels. See link below\",\r\n\r\n \"customField3\": \"https://help.shipstation.com/hc/en-us/articles/206639957\",\r\n\r\n \"source\": \"Webstore\",\r\n\r\n \"billToParty\": null,\r\n\r\n \"billToAccount\": null,\r\n\r\n \"billToPostalCode\": null,\r\n\r\n \"billToCountryCode\": null\r\n\r\n },\r\n\r\n \"tagIds\": [\r\n\r\n 53974\r\n\r\n ]\r\n\r\n }\r\n\r\n ]\r\n contentMediaType: application/json\r\n example: >-\r\n [\r\n\r\n {\r\n\r\n \"orderNumber\": \"TEST-ORDER-API-DOCS\",\r\n\r\n \"orderKey\": \"{{$guid}}\",\r\n\r\n \"orderDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"paymentDate\": \"2015-06-29T08:46:27.0000000\",\r\n\r\n \"shipByDate\": \"2015-07-05T00:00:00.0000000\",\r\n\r\n \"orderStatus\": \"awaiting_shipment\",\r\n\r\n \"customerId\": {{customerId}},\r\n\r\n \"customerUsername\": \"john.smith@gmail.com\",\r\n\r\n \"customerEmail\": \"john.smith@gmail.com\",\r\n\r\n \"billTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": null,\r\n\r\n \"street1\": null,\r\n\r\n \"street2\": null,\r\n\r\n \"street3\": null,\r\n\r\n \"city\": null,\r\n\r\n \"state\": null,\r\n\r\n \"postalCode\": null,\r\n\r\n \"country\": null,\r\n\r\n \"phone\": null,\r\n\r\n \"residential\": null\r\n\r\n },\r\n\r\n \"shipTo\": {\r\n\r\n \"name\": \"The President\",\r\n\r\n \"company\": \"US Govt\",\r\n\r\n \"street1\": \"1600 Pennsylvania Ave\",\r\n\r\n \"street2\": \"Oval Office\",\r\n\r\n \"street3\": null,\r\n\r\n \"city\": \"Washington\",\r\n\r\n \"state\": \"DC\",\r\n\r\n \"postalCode\": \"20500\",\r\n\r\n \"country\": \"US\",\r\n\r\n \"phone\": \"555-555-5555\",\r\n\r\n \"residential\": true\r\n\r\n },\r\n\r\n \"items\": [\r\n\r\n {\r\n\r\n \"lineItemKey\": \"vd08-MSLbtx\",\r\n\r\n \"sku\": \"ABC123\",\r\n\r\n \"name\": \"Test item #1\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 24,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 2,\r\n\r\n \"unitPrice\": 99.99,\r\n\r\n \"taxAmount\": 2.5,\r\n\r\n \"shippingAmount\": 5,\r\n\r\n \"warehouseLocation\": \"Aisle 1, Bin 7\",\r\n\r\n \"options\": [\r\n\r\n {\r\n\r\n \"name\": \"Size\",\r\n\r\n \"value\": \"Large\"\r\n\r\n }\r\n\r\n ],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": null,\r\n\r\n \"adjustment\": false,\r\n\r\n \"upc\": \"32-65-98\"\r\n\r\n },\r\n\r\n {\r\n\r\n \"lineItemKey\": null,\r\n\r\n \"sku\": \"DISCOUNT CODE\",\r\n\r\n \"name\": \"10% OFF\",\r\n\r\n \"imageUrl\": null,\r\n\r\n \"weight\": {\r\n\r\n \"value\": 0,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"quantity\": 1,\r\n\r\n \"unitPrice\": -20.55,\r\n\r\n \"taxAmount\": null,\r\n\r\n \"shippingAmount\": null,\r\n\r\n \"warehouseLocation\": null,\r\n\r\n \"options\": [],\r\n\r\n \"productId\": 123456,\r\n\r\n \"fulfillmentSku\": \"SKU-Discount\",\r\n\r\n \"adjustment\": true,\r\n\r\n \"upc\": null\r\n\r\n }\r\n\r\n ],\r\n\r\n \"amountPaid\": 218.73,\r\n\r\n \"taxAmount\": 5,\r\n\r\n \"shippingAmount\": 10,\r\n\r\n \"customerNotes\": \"Please ship as soon as possible!\",\r\n\r\n \"internalNotes\": \"Customer called and would like to upgrade shipping\",\r\n\r\n \"gift\": true,\r\n\r\n \"giftMessage\": \"Thank you!\",\r\n\r\n \"paymentMethod\": \"Credit Card\",\r\n\r\n \"requestedShippingService\": \"Priority Mail\",\r\n\r\n \"carrierCode\": \"fedex\",\r\n\r\n \"serviceCode\": \"fedex_2day\",\r\n\r\n \"packageCode\": \"package\",\r\n\r\n \"confirmation\": \"delivery\",\r\n\r\n \"shipDate\": \"2015-07-02\",\r\n\r\n \"weight\": {\r\n\r\n \"value\": 25,\r\n\r\n \"units\": \"ounces\"\r\n\r\n },\r\n\r\n \"dimensions\": {\r\n\r\n \"units\": \"inches\",\r\n\r\n \"length\": 7,\r\n\r\n \"width\": 5,\r\n\r\n \"height\": 6\r\n\r\n },\r\n\r\n \"insuranceOptions\": {\r\n\r\n \"provider\": \"carrier\",\r\n\r\n \"insureShipment\": true,\r\n\r\n \"insuredValue\": 200\r\n\r\n },\r\n\r\n \"internationalOptions\": {\r\n\r\n \"contents\": null,\r\n\r\n \"customsItems\": null\r\n\r\n },\r\n\r\n \"advancedOptions\": {\r\n\r\n \"warehouseId\": 0,\r\n\r\n \"nonMachinable\": false,\r\n\r\n \"saturdayDelivery\": false,\r\n\r\n \"containsAlcohol\": false,\r\n\r\n \"mergedOrSplit\": false,\r\n\r\n \"mergedIds\": [],\r\n\r\n \"parentId\": null,\r\n\r\n \"storeId\": 179188,\r\n\r\n \"customField1\": \"Custom data that you can add to an order. See Custom Field #2 & #3 for more info!\",\r\n\r\n \"customField2\": \"Per UI settings, this information can appear on some carrier's shipping labels. See link below\",\r\n\r\n \"customField3\": \"https://help.shipstation.com/hc/en-us/articles/206639957\",\r\n\r\n \"source\": \"Webstore\",\r\n\r\n \"billToParty\": null,\r\n\r\n \"billToAccount\": null,\r\n\r\n \"billToPostalCode\": null,\r\n\r\n \"billToCountryCode\": null\r\n\r\n },\r\n\r\n \"tagIds\": [\r\n\r\n 53974\r\n\r\n ]\r\n\r\n }\r\n\r\n ]\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 17:09:08 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0siEFJQQwMrQ1JWEBVBTgBMCE4IFgABClAOUwJNAFtVBRtDBwIKAwkBWFYGUwFQXFMCVUBKBQNcEV0/\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '52'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '173'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/CreateUpdateMultipleOrders'\r\n - examples:\r\n - hasErrors: false\r\n results:\r\n - orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n success: true\r\n errorMessage: null\r\n contentMediaType: application/json\r\n example:\r\n hasErrors: false\r\n results:\r\n - orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n success: true\r\n errorMessage: null\r\n deprecated: false\r\n parameters: []\r\n //orders/createlabelfororder:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Create Label for Order\r\n 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:'\r\n operationId: CreateLabelforOrder\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"carrierCode\": \"fedex\",\r\n \"serviceCode\": \"fedex_2day\",\r\n \"packageCode\": \"package\",\r\n \"confirmation\": null,\r\n \"shipDate\": \"2021-04-03\",\r\n \"weight\": {\r\n \"value\": 2,\r\n \"units\": \"pounds\"\r\n },\r\n \"dimensions\": null,\r\n \"insuranceOptions\": null,\r\n \"internationalOptions\": null,\r\n \"advancedOptions\": null,\r\n \"testLabel\": false\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"carrierCode\": \"fedex\",\r\n \"serviceCode\": \"fedex_2day\",\r\n \"packageCode\": \"package\",\r\n \"confirmation\": null,\r\n \"shipDate\": \"2021-04-03\",\r\n \"weight\": {\r\n \"value\": 2,\r\n \"units\": \"pounds\"\r\n },\r\n \"dimensions\": null,\r\n \"insuranceOptions\": null,\r\n \"internationalOptions\": null,\r\n \"advancedOptions\": null,\r\n \"testLabel\": false\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //orders/assignuser:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Assign User To Order\r\n description: >-\r\n Assigns a user to an order. The body of this request should specify the following attributes:\r\n\r\n\r\n\r\n - orderIds\r\n\r\n - userId\r\n operationId: AssignUserToOrder\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/AssignUserToOrderRequest'\r\n - examples:\r\n - orderIds:\r\n - 123456789\r\n - 12345679\r\n userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa\r\n contentMediaType: application/json\r\n example:\r\n orderIds:\r\n - 123456789\r\n - 12345679\r\n userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //orders/addtag:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Add Tag To Order\r\n description: >-\r\n Adds a tag to an order. The body of this request should specify the following attributes:\r\n\r\n\r\n\r\n - `orderId`\r\n\r\n - `tagId`\r\n operationId: AddTagToOrder\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"tagId\": 1234\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"tagId\": 1234\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 15:47:57 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0sgBlNlVgFGHQYdUkpTTABTC1MBDQweB1UVQwBZBANUBFYDAFQMCgYFB1YVHVEHCEJTbg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '3'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '52'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/AddTagToOrder'\r\n - examples:\r\n - success: true\r\n message: Tag added successfully.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: Tag added successfully.\r\n deprecated: false\r\n parameters: []\r\n //orders:\r\n get:\r\n tags:\r\n - Orders\r\n summary: List Orders\r\n description: >-\r\n Obtains a list of orders that match the specified criteria. <br/>\r\n\r\n All of the available filters are optional.\r\n operationId: ListOrders\r\n parameters:\r\n - name: customerName\r\n in: query\r\n description: Returns orders that match the specified name.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: itemKeyword\r\n in: query\r\n description: Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: createDateStart\r\n in: query\r\n description: Returns orders that were created in ShipStation after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: createDateEnd\r\n in: query\r\n description: Returns orders that were created in ShipStation before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: modifyDateStart\r\n in: query\r\n description: Returns orders that were modified after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: modifyDateEnd\r\n in: query\r\n description: Returns orders that were modified before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderDateStart\r\n in: query\r\n description: Returns orders greater than the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderDateEnd\r\n in: query\r\n description: Returns orders less than or equal to the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderNumber\r\n in: query\r\n description: Filter by order number, performs a \"starts with\" search.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderStatus\r\n in: query\r\n description: Filter by order status. If left empty, orders of all statuses are returned.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: paymentDateStart\r\n in: query\r\n description: Returns orders that were paid after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: paymentDateEnd\r\n in: query\r\n description: Returns orders that were paid before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: storeId\r\n in: query\r\n description: Filters orders to a single store. Call List Stores to obtain a list of store Ids.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortBy\r\n in: query\r\n 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.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortDir\r\n in: query\r\n description: Sets the direction of the sort order.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: page\r\n in: query\r\n description: Page number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: pageSize\r\n in: query\r\n description: Requested page size. Max value is 500.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: Authorization\r\n in: header\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n examples:\r\n - '{{authToken}}'\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 01:49:01 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n ss-api-server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: SS-L-WEB02\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0stC0RFFUpUHwYfUkhSUwZXClYKFBkDH0ddWQBXAgEHUwJYAgJdBwIBQ05RUFsVAWw=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '59'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '10008'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/ListOrders'\r\n - examples:\r\n - orders:\r\n - orderId: 21533276\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0d6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:12:33.7400000\r\n modifyDate: 2021-01-23T17:12:52.1970000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318261\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n - orderItemId: 32318262\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n - orderId: 21533759\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: b0a0422e-af18-4ff6-a9d4-ceb4d010947c\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:15:54.7530000\r\n modifyDate: 2021-01-23T17:16:13.2900000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318921\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:15:54.66\r\n modifyDate: 2021-01-23T17:15:54.66\r\n - orderItemId: 32318922\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:15:54.66\r\n modifyDate: 2021-01-23T17:15:54.66\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 246f6803-5081-48bf-b134-1bd5fc74b760\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:16:41.3570000\r\n modifyDate: 2021-01-23T17:16:59.9300000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32319106\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n - orderItemId: 32319107\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2021-04-03\r\n holdUntilDate: null\r\n weight:\r\n value: 32\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n total: 3\r\n page: 1\r\n pages: 1\r\n contentMediaType: application/json\r\n example:\r\n orders:\r\n - orderId: 21533276\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0d6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:12:33.7400000\r\n modifyDate: 2021-01-23T17:12:52.1970000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318261\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n - orderItemId: 32318262\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n - orderId: 21533759\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: b0a0422e-af18-4ff6-a9d4-ceb4d010947c\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:15:54.7530000\r\n modifyDate: 2021-01-23T17:16:13.2900000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318921\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:15:54.66\r\n modifyDate: 2021-01-23T17:15:54.66\r\n - orderItemId: 32318922\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:15:54.66\r\n modifyDate: 2021-01-23T17:15:54.66\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 246f6803-5081-48bf-b134-1bd5fc74b760\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:16:41.3570000\r\n modifyDate: 2021-01-23T17:16:59.9300000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32319106\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n - orderItemId: 32319107\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2021-04-03\r\n holdUntilDate: null\r\n weight:\r\n value: 32\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n total: 3\r\n page: 1\r\n pages: 1\r\n deprecated: false\r\n security: []\r\n parameters: []\r\n //orders/listbytag:\r\n get:\r\n tags:\r\n - Orders\r\n summary: List Orders By Tag\r\n description: ists all orders that match the specified status and tag ID.\r\n operationId: ListOrdersByTag\r\n parameters:\r\n - name: orderStatus\r\n in: query\r\n description: The order's status.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: tagId\r\n in: query\r\n description: ID of the tag. Call Accounts/ListTags to obtain a list of tags for this account.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: page\r\n in: query\r\n description: Page number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: pageSize\r\n in: query\r\n description: Requested page size. Max value is 500.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //orders/{orderId}:\r\n get:\r\n tags:\r\n - Orders\r\n summary: Get Order\r\n description: Retrieve a single order from the database.\r\n operationId: GetOrder\r\n parameters:\r\n - name: orderId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 01:59:14 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0smB0MTG1ZKARoDTFZUVgZTDVAUFQUeEQFbWQcCUlcFUwADVFoMUgZGTQRWXUQDOQ==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '45'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '3320'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetOrder'\r\n - examples:\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 246f6803-5081-48bf-b134-1bd5fc74b760\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:16:41.3570000\r\n modifyDate: 2021-01-23T17:16:59.9300000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32319106\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n - orderItemId: 32319107\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2021-04-03\r\n holdUntilDate: null\r\n weight:\r\n value: 32\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n contentMediaType: application/json\r\n example:\r\n orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 246f6803-5081-48bf-b134-1bd5fc74b760\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:16:41.3570000\r\n modifyDate: 2021-01-23T17:16:59.9300000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32319106\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n - orderItemId: 32319107\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2021-04-03\r\n holdUntilDate: null\r\n weight:\r\n value: 32\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n deprecated: false\r\n delete:\r\n tags:\r\n - Orders\r\n summary: Delete Order\r\n 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.\r\n operationId: DeleteOrder\r\n parameters:\r\n - name: orderId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 17:25:55 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0slB1tUQwNGHQYdUkpTTABbD1EPCAEeHlQVQwlSBgBUDwZSUFtcVVZSAFoVHVEHCEJTbg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '4'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '66'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/DeleteOrder'\r\n - examples:\r\n - success: true\r\n message: The requested order has been deleted.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested order has been deleted.\r\n deprecated: false\r\n parameters: []\r\n //orders/holduntil:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Hold Order Until\r\n 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.\r\n operationId: HoldOrderUntil\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"holdUntilDate\": \"2021-12-01\"\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"holdUntilDate\": \"2021-12-01\"\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:00:23 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0spDVtVYggQWFoRTlZNUhxSFlABAQIFCkkMWR1DA1UCBlRQA1dZV1UGWFJTVRVKAlBaQAc7\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '37'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '53'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/HoldOrderUntil'\r\n - examples:\r\n - success: true\r\n message: Order held successfully.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: Order held successfully.\r\n deprecated: false\r\n parameters: []\r\n //orders/markasshipped:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Mark an Order as Shipped\r\n description: Marks an order as shipped without creating a label in ShipStation.\r\n operationId: MarkanOrderasShipped\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"carrierCode\": \"usps\",\r\n \"shipDate\": \"2021-01-24\",\r\n \"trackingNumber\": \"913492493294329421\",\r\n \"notifyCustomer\": true,\r\n \"notifySalesChannel\": true\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"carrierCode\": \"usps\",\r\n \"shipDate\": \"2021-01-24\",\r\n \"trackingNumber\": \"913492493294329421\",\r\n \"notifyCustomer\": true,\r\n \"notifySalesChannel\": true\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:01:29 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0ssA0VadhU3WV9DEgMHQBxSFlIUCBoBBlwKWAZWH1NTABtDB1YJAgAAWQNVUlYDXQJQCkBKBQNcEV0/\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '30'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '56'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/MarkanOrderasShipped'\r\n - examples:\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n contentMediaType: application/json\r\n example:\r\n orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n deprecated: false\r\n parameters: []\r\n //orders/removetag:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Remove Tag from Order\r\n description: Removes a tag from the specified order.\r\n operationId: RemoveTagfromOrder\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"tagId\": 1234\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"orderId\": {{orderId}},\r\n \"tagId\": 1234\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:02:20 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0szB1peQQMwUFERTlZNUhxSFlIJDAYEBlIVVQNNEVUFAFNWAgBbVQFQU1oFAFRESFdXXxEDPg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '38'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '54'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/RemoveTagfromOrder'\r\n - examples:\r\n - success: true\r\n message: Tag removed successfully.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: Tag removed successfully.\r\n deprecated: false\r\n parameters: []\r\n //orders/restorefromhold:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Restore Order from On Hold\r\n 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.\r\n operationId: RestoreOrderfromOnHold\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"orderId\": {{orderId}}\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"orderId\": {{orderId}}\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:02:51 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC4UB11BQ0szB0RFWBQBd0RcDy4MDlRAFFIWCBgCHVQJUwJYBE5WAxtDVgFbBFJWWQQHVwBVVwkOAkBKBQNcEV0/\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '35'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '8'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '66'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/RestoreOrderfromOnHold'\r\n - examples:\r\n - success: true\r\n message: The requested order has been restored\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested order has been restored\r\n deprecated: false\r\n parameters: []\r\n //orders/unassignuser:\r\n post:\r\n tags:\r\n - Orders\r\n summary: Unassign User from Order\r\n description: Unassigns a user from an order.\r\n operationId: UnassignUserfromOrder\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/UnassignUserfromOrderRequest'\r\n - examples:\r\n - orderIds:\r\n - 123456789\r\n - 12345679\r\n contentMediaType: application/json\r\n example:\r\n orderIds:\r\n - 123456789\r\n - 12345679\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //products/{productId}:\r\n get:\r\n tags:\r\n - Products\r\n summary: Get a Product\r\n operationId: GetaProduct\r\n parameters:\r\n - name: productId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 17:49:41 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDEUDFxGUxASTXBUQ0RIARgDTlZNUgNUCVsNABgfAkkbWFAFAFZXD1NXVlMNV1FRB0AbV1YKF1Rr\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '19'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '694'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetaProduct'\r\n - examples:\r\n - aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n contentMediaType: application/json\r\n example:\r\n aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n deprecated: false\r\n put:\r\n tags:\r\n - Products\r\n summary: Update a Product\r\n 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.\r\n operationId: UpdateaProduct\r\n parameters:\r\n - name: productId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"aliases\": null,\r\n \"productId\": {{productId}},\r\n \"sku\": \"BEAU-000\",\r\n \"name\": \"Beautiful\",\r\n \"price\": 0,\r\n \"defaultCost\": null,\r\n \"length\": null,\r\n \"width\": null,\r\n \"height\": null,\r\n \"weightOz\": null,\r\n \"internalNotes\": null,\r\n \"fulfillmentSku\": null,\r\n \"active\": true,\r\n \"productCategory\": null,\r\n \"productType\": null,\r\n \"warehouseLocation\": null,\r\n \"defaultCarrierCode\": null,\r\n \"defaultServiceCode\": null,\r\n \"defaultPackageCode\": null,\r\n \"defaultIntlCarrierCode\": null,\r\n \"defaultIntlServiceCode\": null,\r\n \"defaultIntlPackageCode\": null,\r\n \"defaultConfirmation\": null,\r\n \"defaultIntlConfirmation\": null,\r\n \"customsDescription\": null,\r\n \"customsValue\": null,\r\n \"customsTariffNo\": null,\r\n \"customsCountryCode\": null,\r\n \"noCustoms\": null,\r\n \"tags\": null\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"aliases\": null,\r\n \"productId\": {{productId}},\r\n \"sku\": \"BEAU-000\",\r\n \"name\": \"Beautiful\",\r\n \"price\": 0,\r\n \"defaultCost\": null,\r\n \"length\": null,\r\n \"width\": null,\r\n \"height\": null,\r\n \"weightOz\": null,\r\n \"internalNotes\": null,\r\n \"fulfillmentSku\": null,\r\n \"active\": true,\r\n \"productCategory\": null,\r\n \"productType\": null,\r\n \"warehouseLocation\": null,\r\n \"defaultCarrierCode\": null,\r\n \"defaultServiceCode\": null,\r\n \"defaultPackageCode\": null,\r\n \"defaultIntlCarrierCode\": null,\r\n \"defaultIntlServiceCode\": null,\r\n \"defaultIntlPackageCode\": null,\r\n \"defaultConfirmation\": null,\r\n \"defaultIntlConfirmation\": null,\r\n \"customsDescription\": null,\r\n \"customsValue\": null,\r\n \"customsTariffNo\": null,\r\n \"customsCountryCode\": null,\r\n \"noCustoms\": null,\r\n \"tags\": null\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:33:59 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDEUDFxGUxASTWJBUwcQVBQfUkhTTgBMCFEACAEAAEkOVAJNEQRUVQFXVFoOBQRcVlVTAwJESFdXXxEDPg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '60'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '67'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/UpdateaProduct'\r\n - examples:\r\n - success: true\r\n message: The requested product has been updated\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested product has been updated\r\n deprecated: false\r\n parameters: []\r\n //products:\r\n get:\r\n tags:\r\n - Products\r\n summary: List Products\r\n 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.\r\n operationId: ListProducts\r\n parameters:\r\n - name: sku\r\n in: query\r\n description: Returns products that match the specified SKU.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: name\r\n in: query\r\n description: Returns products that match the specified product name.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: productCategoryId\r\n in: query\r\n description: Returns products that match the specified productCategoryId.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: productTypeId\r\n in: query\r\n description: Returns products that match the specified productTypeId.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: tagId\r\n in: query\r\n description: Returns products that match the specified tagId.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: startDate\r\n in: query\r\n description: Returns products that were created after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: endDate\r\n in: query\r\n description: Returns products that were created before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: showInactive\r\n in: query\r\n description: Specifies whether the list should include inactive products.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortBy\r\n in: query\r\n description: Sorts the order of the response based off the specified value.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortDir\r\n in: query\r\n description: Sets the direction of the sort order.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: page\r\n in: query\r\n description: Page number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: pageSize\r\n in: query\r\n description: Requested page size. Max value is 500.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 17:48:24 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDEUDFxGUxASTXtYRBJGHQYdUkpTTABUCVYMCwweHlQVQwcEBQECAg5RUVReAQJXVFsVHVEHCEJTbg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '36'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '738'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/ListProducts'\r\n - examples:\r\n - products:\r\n - aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n total: 1\r\n page: 1\r\n pages: 0\r\n contentMediaType: application/json\r\n example:\r\n products:\r\n - aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n total: 1\r\n page: 1\r\n pages: 0\r\n deprecated: false\r\n parameters: []\r\n //shipments/createlabel:\r\n post:\r\n tags:\r\n - Shipment\r\n summary: Create Shipment Label\r\n 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.\r\n operationId: CreateShipmentLabel\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/CreateShipmentLabelRequest'\r\n - examples:\r\n - carrierCode: fedex\r\n serviceCode: fedex_ground\r\n packageCode: package\r\n confirmation: delivery\r\n shipDate: 2021-04-03\r\n weight:\r\n value: 3\r\n units: ounces\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n shipFrom:\r\n name: Jason Hodges\r\n company: ShipStation\r\n street1: 2815 Exposition Blvd\r\n street2: Ste 2353242\r\n street3: null\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n country: US\r\n phone: null\r\n residential: false\r\n shipTo:\r\n name: The President\r\n company: US Govt\r\n street1: 1600 Pennsylvania Ave\r\n street2: Oval Office\r\n street3: null\r\n city: Washington\r\n state: DC\r\n postalCode: '20500'\r\n country: US\r\n phone: null\r\n residential: false\r\n insuranceOptions: null\r\n internationalOptions: null\r\n advancedOptions: null\r\n testLabel: false\r\n contentMediaType: application/json\r\n example:\r\n carrierCode: fedex\r\n serviceCode: fedex_ground\r\n packageCode: package\r\n confirmation: delivery\r\n shipDate: 2021-04-03\r\n weight:\r\n value: 3\r\n units: ounces\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n shipFrom:\r\n name: Jason Hodges\r\n company: ShipStation\r\n street1: 2815 Exposition Blvd\r\n street2: Ste 2353242\r\n street3: null\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n country: US\r\n phone: null\r\n residential: false\r\n shipTo:\r\n name: The President\r\n company: US Govt\r\n street1: 1600 Pennsylvania Ave\r\n street2: Oval Office\r\n street3: null\r\n city: Washington\r\n state: DC\r\n postalCode: '20500'\r\n country: US\r\n phone: null\r\n residential: false\r\n insuranceOptions: null\r\n internationalOptions: null\r\n advancedOptions: null\r\n testLabel: false\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //shipments/getrates:\r\n post:\r\n tags:\r\n - Shipment\r\n summary: Get Rates\r\n description: Retrieves shipping rates for the specified shipping details.\r\n operationId: GetRates\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetRatesRequest'\r\n - examples:\r\n - carrierCode: fedex\r\n serviceCode: null\r\n packageCode: null\r\n fromPostalCode: '78703'\r\n toState: DC\r\n toCountry: US\r\n toPostalCode: '20500'\r\n toCity: Washington\r\n weight:\r\n value: 3\r\n units: ounces\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n confirmation: delivery\r\n residential: false\r\n contentMediaType: application/json\r\n example:\r\n carrierCode: fedex\r\n serviceCode: null\r\n packageCode: null\r\n fromPostalCode: '78703'\r\n toState: DC\r\n toCountry: US\r\n toPostalCode: '20500'\r\n toCity: Washington\r\n weight:\r\n value: 3\r\n units: ounces\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n confirmation: delivery\r\n residential: false\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 17:59:04 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDIOCkheVQoVERh2UhI2UEJWEURPUh5SFFMWCQcBAlcBVR1VA1VIFFIEUwEIUgZQAwNRBAUAXVQUHwQHDxFVPw==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '57'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '2278'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/GetRate'\r\n description: ''\r\n examples:\r\n - - serviceName: USPS First Class Mail - Letter\r\n serviceCode: usps_first_class_mail\r\n shipmentCost: 0.8\r\n otherCost: 0\r\n - serviceName: USPS First Class Mail - Package\r\n serviceCode: usps_first_class_mail\r\n shipmentCost: 2.93\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Package\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.98\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Medium Flat Rate Box\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 13.2\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Small Flat Rate Box\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.65\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Large Flat Rate Box\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 18.3\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Flat Rate Envelope\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.15\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Flat Rate Padded Envelope\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.75\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Regional Rate Box A\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 10.42\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Regional Rate Box B\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 16.72\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Legal Flat Rate Envelope\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.45\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Package\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 28.25\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Flat Rate Envelope\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 22.75\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Flat Rate Padded Envelope\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 23.25\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Legal Flat Rate Envelope\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 22.95\r\n otherCost: 0\r\n - serviceName: USPS Media Mail - Package\r\n serviceCode: usps_media_mail\r\n shipmentCost: 2.8\r\n otherCost: 0\r\n - serviceName: USPS Parcel Select Ground - Package\r\n serviceCode: usps_parcel_select\r\n shipmentCost: 7.78\r\n otherCost: 0\r\n contentMediaType: application/json\r\n example:\r\n - serviceName: USPS First Class Mail - Letter\r\n serviceCode: usps_first_class_mail\r\n shipmentCost: 0.8\r\n otherCost: 0\r\n - serviceName: USPS First Class Mail - Package\r\n serviceCode: usps_first_class_mail\r\n shipmentCost: 2.93\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Package\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.98\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Medium Flat Rate Box\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 13.2\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Small Flat Rate Box\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.65\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Large Flat Rate Box\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 18.3\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Flat Rate Envelope\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.15\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Flat Rate Padded Envelope\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.75\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Regional Rate Box A\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 10.42\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Regional Rate Box B\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 16.72\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail - Legal Flat Rate Envelope\r\n serviceCode: usps_priority_mail\r\n shipmentCost: 7.45\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Package\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 28.25\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Flat Rate Envelope\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 22.75\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Flat Rate Padded Envelope\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 23.25\r\n otherCost: 0\r\n - serviceName: USPS Priority Mail Express - Legal Flat Rate Envelope\r\n serviceCode: usps_priority_mail_express\r\n shipmentCost: 22.95\r\n otherCost: 0\r\n - serviceName: USPS Media Mail - Package\r\n serviceCode: usps_media_mail\r\n shipmentCost: 2.8\r\n otherCost: 0\r\n - serviceName: USPS Parcel Select Ground - Package\r\n serviceCode: usps_parcel_select\r\n shipmentCost: 7.78\r\n otherCost: 0\r\n deprecated: false\r\n parameters: []\r\n //shipments:\r\n get:\r\n tags:\r\n - Shipment\r\n summary: List Shipments\r\n description: Obtains a list of shipments that match the specified criteria.\r\n operationId: ListShipments\r\n parameters:\r\n - name: recipientName\r\n in: query\r\n description: Returns shipments shipped to the specified recipient name.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: recipientCountryCode\r\n in: query\r\n description: Returns shipments shipped to the specified country code.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderNumber\r\n in: query\r\n description: Returns shipments whose orders have the specified order number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: orderId\r\n in: query\r\n description: Returns shipments whose orders have the specified order ID.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: carrierCode\r\n in: query\r\n description: Returns shipments shipped with the specified carrier.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: serviceCode\r\n in: query\r\n description: Returns shipments shipped with the specified shipping service.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: trackingNumber\r\n in: query\r\n description: Returns shipments with the specified tracking number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: createDateStart\r\n in: query\r\n description: Returns shipments created on or after the specified createDate.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: createDateEnd\r\n in: query\r\n description: Returns shipments created on or before the specified createDate.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: shipDateStart\r\n in: query\r\n description: Returns shipments with the shipDate on or after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: shipDateEnd\r\n in: query\r\n description: Returns shipments with the shipDate on or before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: voidDateStart\r\n in: query\r\n description: Returns shipments voided on or after the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: voidDateEnd\r\n in: query\r\n description: Returns shipments voided on or before the specified date.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: storeId\r\n in: query\r\n description: Returns shipments whose orders belong to the specified store ID.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: includeShipmentItems\r\n in: query\r\n description: 'Specifies whether to include shipment items with results Default value: false.'\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortBy\r\n in: query\r\n 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.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: sortDir\r\n in: query\r\n description: Sets the direction of the sort order.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: page\r\n in: query\r\n description: Page number.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n - name: pageSize\r\n in: query\r\n description: Page size.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - <>\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //shipments/voidlabel:\r\n post:\r\n tags:\r\n - Shipment\r\n summary: Void Shipment Label\r\n description: Voids the specified label by shipmentId.\r\n operationId: VoidShipmentLabel\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/VoidShipmentLabelRequest'\r\n - examples:\r\n - shipmentId: 12345\r\n contentMediaType: application/json\r\n example:\r\n shipmentId: 12345\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //stores:\r\n get:\r\n tags:\r\n - Stores\r\n summary: List Stores\r\n description: Retrieve the list of installed stores on the account.\r\n operationId: ListStores\r\n parameters: []\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:44:23 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDISDEpWQ0stC0RFFUpUHwYfUkhTUQRUDFEBFBkDH0cAVlRZAlJVB1YHB1cNBQUGQ05RUFsVAWw=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '36'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '788'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListStore'\r\n description: ''\r\n examples:\r\n - - storeId: 179188\r\n storeName: Manual Orders\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: ''\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T05:23:13.067\r\n modifyDate: 2021-01-23T05:23:13.067\r\n autoRefresh: false\r\n statusMappings: null\r\n - storeId: 179331\r\n storeName: MyDemoStore\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: null\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T09:02:04.683\r\n modifyDate: 2021-01-23T09:02:04.697\r\n autoRefresh: true\r\n statusMappings: null\r\n contentMediaType: application/json\r\n example:\r\n - storeId: 179188\r\n storeName: Manual Orders\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: ''\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T05:23:13.067\r\n modifyDate: 2021-01-23T05:23:13.067\r\n autoRefresh: false\r\n statusMappings: null\r\n - storeId: 179331\r\n storeName: MyDemoStore\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: null\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T09:02:04.683\r\n modifyDate: 2021-01-23T09:02:04.697\r\n autoRefresh: true\r\n statusMappings: null\r\n deprecated: false\r\n parameters: []\r\n //stores/{storeId}:\r\n get:\r\n tags:\r\n - Stores\r\n summary: Get Store\r\n operationId: GetStore\r\n parameters:\r\n - name: storeId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 02:45:27 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDISDEpWQ0smB0MTG1ZKARoDTFZaWghTDlYUFQUeEVZbVAVZCwNWDlYDVlNZAFRGTQRWXUQDOQ==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '32'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '393'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetStore'\r\n - examples:\r\n - storeId: 179188\r\n storeName: Manual Orders\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: ''\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T05:23:13.067\r\n modifyDate: 2021-01-23T05:23:13.067\r\n autoRefresh: false\r\n statusMappings: null\r\n contentMediaType: application/json\r\n example:\r\n storeId: 179188\r\n storeName: Manual Orders\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: ''\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T05:23:13.067\r\n modifyDate: 2021-01-23T05:23:13.067\r\n autoRefresh: false\r\n statusMappings: null\r\n deprecated: false\r\n put:\r\n tags:\r\n - Stores\r\n summary: Update Store\r\n description: Updates an existing store.\r\n operationId: UpdateStore\r\n parameters:\r\n - name: storeId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"storeId\": {{storeId}},\r\n \"storeName\": \"Demo Store\",\r\n \"marketplaceId\": 0,\r\n \"marketplaceName\": \"ShipStation\",\r\n \"accountName\": null,\r\n \"email\": null,\r\n \"integrationUrl\": \"http://shipstation-test.wpengine.com\",\r\n \"active\": true,\r\n \"companyName\": \"\",\r\n \"phone\": \"\",\r\n \"publicEmail\": \"\",\r\n \"website\": \"\",\r\n \"refreshDate\": \"2014-12-16T17:47:05.457\",\r\n \"lastRefreshAttempt\": \"2014-12-16T09:47:05.457\",\r\n \"createDate\": \"2014-11-06T15:21:13.223\",\r\n \"modifyDate\": \"2014-11-10T08:02:19.117\",\r\n \"autoRefresh\": true,\r\n \"statusMappings\": [\r\n {\r\n \"orderStatus\": \"awaiting_payment\",\r\n \"statusKey\": \"Pending\"\r\n },\r\n {\r\n \"orderStatus\": \"awaiting_shipment\",\r\n \"statusKey\": \"Processing\"\r\n },\r\n {\r\n \"orderStatus\": \"shipped\",\r\n \"statusKey\": \"Completed\"\r\n },\r\n {\r\n \"orderStatus\": \"cancelled\",\r\n \"statusKey\": \"Cancelled\"\r\n },\r\n {\r\n \"orderStatus\": \"on_hold\",\r\n \"statusKey\": \"On-hold\"\r\n }\r\n ]\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"storeId\": {{storeId}},\r\n \"storeName\": \"Demo Store\",\r\n \"marketplaceId\": 0,\r\n \"marketplaceName\": \"ShipStation\",\r\n \"accountName\": null,\r\n \"email\": null,\r\n \"integrationUrl\": \"http://shipstation-test.wpengine.com\",\r\n \"active\": true,\r\n \"companyName\": \"\",\r\n \"phone\": \"\",\r\n \"publicEmail\": \"\",\r\n \"website\": \"\",\r\n \"refreshDate\": \"2014-12-16T17:47:05.457\",\r\n \"lastRefreshAttempt\": \"2014-12-16T09:47:05.457\",\r\n \"createDate\": \"2014-11-06T15:21:13.223\",\r\n \"modifyDate\": \"2014-11-10T08:02:19.117\",\r\n \"autoRefresh\": true,\r\n \"statusMappings\": [\r\n {\r\n \"orderStatus\": \"awaiting_payment\",\r\n \"statusKey\": \"Pending\"\r\n },\r\n {\r\n \"orderStatus\": \"awaiting_shipment\",\r\n \"statusKey\": \"Processing\"\r\n },\r\n {\r\n \"orderStatus\": \"shipped\",\r\n \"statusKey\": \"Completed\"\r\n },\r\n {\r\n \"orderStatus\": \"cancelled\",\r\n \"statusKey\": \"Cancelled\"\r\n },\r\n {\r\n \"orderStatus\": \"on_hold\",\r\n \"statusKey\": \"On-hold\"\r\n }\r\n ]\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //stores/deactivate:\r\n post:\r\n tags:\r\n - Stores\r\n summary: Deactivate Store\r\n description: Deactivates the specified store.\r\n operationId: DeactivateStore\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/DeactivateStoreRequest'\r\n - examples:\r\n - storeId: '{{storeId}}'\r\n contentMediaType: application/json\r\n example:\r\n storeId: '{{storeId}}'\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 03:02:03 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDISDEpWQ0slB1ZSQw8SUEJWQEpTTABOCEwJCgwAB1ANTQNUH0BXB1NUXgcMAwFRBQdWUFMERh1QUg4VBj8=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '57'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '70'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/DeactivateStore'\r\n - examples:\r\n - success: true\r\n message: The requested store has been deactivated.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested store has been deactivated.\r\n deprecated: false\r\n parameters: []\r\n //stores/reactivate:\r\n post:\r\n tags:\r\n - Stores\r\n summary: Reactivate Store\r\n description: Reactivates the specified store.\r\n operationId: ReactivateStore\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/ReactivateStoreRequest'\r\n - examples:\r\n - storeId: '{{storeId}}'\r\n contentMediaType: application/json\r\n example:\r\n storeId: '{{storeId}}'\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 03:02:15 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDISDEpWQ0szB1ZSQw8SUEJWQEpTTABOCEwJDgMKBVwITQNUH0BUAgVXV1JcB1QCVlcGBgJQRh1QUg4VBj8=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '38'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '45'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '70'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/ReactivateStore'\r\n - examples:\r\n - success: true\r\n message: The requested store has been reactivated.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested store has been reactivated.\r\n deprecated: false\r\n parameters: []\r\n //stores/marketplaces:\r\n get:\r\n tags:\r\n - Stores\r\n summary: List Marketplaces\r\n description: Lists the marketplaces that can be integrated with ShipStation.\r\n operationId: ListMarketplaces\r\n parameters: []\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:07:16 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDISDEpWQ0ssA0VaUhIUXVdQBxVBTgBMCE4IFgQGClQLVwZNHlNIFAcDUQAAClFcUFIBVQVSVAYUHwQHDxFVPw==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '44'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '15087'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListMarketplace'\r\n description: ''\r\n examples:\r\n - - name: 3dcart\r\n marketplaceId: 23\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Acumatica\r\n marketplaceId: 115\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Alibaba\r\n marketplaceId: 140\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon\r\n marketplaceId: 2\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon AU\r\n marketplaceId: 113\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon CA\r\n marketplaceId: 32\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon DE\r\n marketplaceId: 42\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon ES\r\n marketplaceId: 43\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon FR\r\n marketplaceId: 44\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon IT\r\n marketplaceId: 45\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon MX\r\n marketplaceId: 87\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon UK\r\n marketplaceId: 15\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: AmeriCommerce\r\n marketplaceId: 59\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Bandcamp\r\n marketplaceId: 109\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Big Cartel\r\n marketplaceId: 86\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: BigCommerce\r\n marketplaceId: 13\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Bizelo\r\n marketplaceId: 29\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Bonanza\r\n marketplaceId: 63\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Brightpearl\r\n marketplaceId: 41\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CDiscount\r\n marketplaceId: 139\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ChannelAdvisor\r\n marketplaceId: 18\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ChannelSale\r\n marketplaceId: 104\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Cin7\r\n marketplaceId: 108\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CoreCommerce\r\n marketplaceId: 105\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CrateJoy\r\n marketplaceId: 79\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CSCart\r\n marketplaceId: 62\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Custom Store\r\n marketplaceId: 22\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: DearSystems\r\n marketplaceId: 80\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay\r\n marketplaceId: 1\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay AU\r\n marketplaceId: 99\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay FR\r\n marketplaceId: 141\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay UK\r\n marketplaceId: 52\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Ecwid\r\n marketplaceId: 92\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Etsy\r\n marketplaceId: 8\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: FoxyCart\r\n marketplaceId: 61\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Freestyle\r\n marketplaceId: 81\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Fullscreen Direct\r\n marketplaceId: 75\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: GeekSeller\r\n marketplaceId: 106\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Goodsie\r\n marketplaceId: 33\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Google\r\n marketplaceId: 143\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Groopdealz\r\n marketplaceId: 78\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: GrouponGoods\r\n marketplaceId: 68\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Handshake\r\n marketplaceId: 114\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Hatch\r\n marketplaceId: 83\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Houzz\r\n marketplaceId: 100\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: InkSoft\r\n marketplaceId: 130\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: JANE\r\n marketplaceId: 55\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Linnworks\r\n marketplaceId: 85\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ListingMirror\r\n marketplaceId: 123\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Magento\r\n marketplaceId: 28\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: MijoShop\r\n marketplaceId: 64\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Mirakl\r\n marketplaceId: 131\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Miva Merchant\r\n marketplaceId: 54\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: MoreCommerce\r\n marketplaceId: 66\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Mozu\r\n marketplaceId: 94\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: NewEgg\r\n marketplaceId: 34\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Newegg Business\r\n marketplaceId: 73\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Newegg Canada\r\n marketplaceId: 90\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: notonthehighstreet\r\n marketplaceId: 136\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ODBC\r\n marketplaceId: 102\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: OpenCart\r\n marketplaceId: 19\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Order Time\r\n marketplaceId: 128\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Oxatis\r\n marketplaceId: 142\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: PayPal\r\n marketplaceId: 6\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: PrestaShop\r\n marketplaceId: 51\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Reverb\r\n marketplaceId: 69\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Revolution Parts\r\n marketplaceId: 112\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Salesforce Commerce Cloud\r\n marketplaceId: 111\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Salesforce Core\r\n marketplaceId: 135\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SAP Anywhere\r\n marketplaceId: 107\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Sears\r\n marketplaceId: 25\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SellBrite\r\n marketplaceId: 82\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SellerActive\r\n marketplaceId: 65\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: ShipEngine API\r\n marketplaceId: 118\r\n canRefresh: false\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: ShipStation\r\n marketplaceId: 0\r\n canRefresh: false\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: Shopify\r\n marketplaceId: 14\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SkuVault\r\n marketplaceId: 60\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Soldsie\r\n marketplaceId: 49\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Sophio\r\n marketplaceId: 39\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Spark Shipping\r\n marketplaceId: 103\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Square\r\n marketplaceId: 70\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Squarespace\r\n marketplaceId: 57\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Stitch Labs\r\n marketplaceId: 26\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Storenvy\r\n marketplaceId: 40\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Stripe\r\n marketplaceId: 95\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SureDone\r\n marketplaceId: 88\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Tanga\r\n marketplaceId: 96\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Tophatter\r\n marketplaceId: 101\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: topShelf\r\n marketplaceId: 27\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: TradeGecko\r\n marketplaceId: 67\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: UltraCart\r\n marketplaceId: 35\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: VisualSoft\r\n marketplaceId: 133\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Volo\r\n marketplaceId: 129\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Volusion\r\n marketplaceId: 7\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Walmart\r\n marketplaceId: 93\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Weebly\r\n marketplaceId: 97\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Wish\r\n marketplaceId: 48\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Wix\r\n marketplaceId: 119\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: WooCommerce\r\n marketplaceId: 36\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: X-Cart\r\n marketplaceId: 17\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Yahoo\r\n marketplaceId: 24\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Zen Cart\r\n marketplaceId: 10\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Zoey\r\n marketplaceId: 84\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n contentMediaType: application/json\r\n example:\r\n - name: 3dcart\r\n marketplaceId: 23\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Acumatica\r\n marketplaceId: 115\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Alibaba\r\n marketplaceId: 140\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon\r\n marketplaceId: 2\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon AU\r\n marketplaceId: 113\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon CA\r\n marketplaceId: 32\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon DE\r\n marketplaceId: 42\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon ES\r\n marketplaceId: 43\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon FR\r\n marketplaceId: 44\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon IT\r\n marketplaceId: 45\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon MX\r\n marketplaceId: 87\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Amazon UK\r\n marketplaceId: 15\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: AmeriCommerce\r\n marketplaceId: 59\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Bandcamp\r\n marketplaceId: 109\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Big Cartel\r\n marketplaceId: 86\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: BigCommerce\r\n marketplaceId: 13\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Bizelo\r\n marketplaceId: 29\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Bonanza\r\n marketplaceId: 63\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Brightpearl\r\n marketplaceId: 41\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CDiscount\r\n marketplaceId: 139\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ChannelAdvisor\r\n marketplaceId: 18\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ChannelSale\r\n marketplaceId: 104\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Cin7\r\n marketplaceId: 108\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CoreCommerce\r\n marketplaceId: 105\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CrateJoy\r\n marketplaceId: 79\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: CSCart\r\n marketplaceId: 62\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Custom Store\r\n marketplaceId: 22\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: DearSystems\r\n marketplaceId: 80\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay\r\n marketplaceId: 1\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay AU\r\n marketplaceId: 99\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay FR\r\n marketplaceId: 141\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: eBay UK\r\n marketplaceId: 52\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Ecwid\r\n marketplaceId: 92\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Etsy\r\n marketplaceId: 8\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: FoxyCart\r\n marketplaceId: 61\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Freestyle\r\n marketplaceId: 81\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Fullscreen Direct\r\n marketplaceId: 75\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: GeekSeller\r\n marketplaceId: 106\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Goodsie\r\n marketplaceId: 33\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Google\r\n marketplaceId: 143\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Groopdealz\r\n marketplaceId: 78\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: GrouponGoods\r\n marketplaceId: 68\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Handshake\r\n marketplaceId: 114\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Hatch\r\n marketplaceId: 83\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Houzz\r\n marketplaceId: 100\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: InkSoft\r\n marketplaceId: 130\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: JANE\r\n marketplaceId: 55\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Linnworks\r\n marketplaceId: 85\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ListingMirror\r\n marketplaceId: 123\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Magento\r\n marketplaceId: 28\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: MijoShop\r\n marketplaceId: 64\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Mirakl\r\n marketplaceId: 131\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Miva Merchant\r\n marketplaceId: 54\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: MoreCommerce\r\n marketplaceId: 66\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Mozu\r\n marketplaceId: 94\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: NewEgg\r\n marketplaceId: 34\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Newegg Business\r\n marketplaceId: 73\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Newegg Canada\r\n marketplaceId: 90\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: notonthehighstreet\r\n marketplaceId: 136\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: ODBC\r\n marketplaceId: 102\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: OpenCart\r\n marketplaceId: 19\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Order Time\r\n marketplaceId: 128\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Oxatis\r\n marketplaceId: 142\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: PayPal\r\n marketplaceId: 6\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: PrestaShop\r\n marketplaceId: 51\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Reverb\r\n marketplaceId: 69\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Revolution Parts\r\n marketplaceId: 112\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Salesforce Commerce Cloud\r\n marketplaceId: 111\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Salesforce Core\r\n marketplaceId: 135\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SAP Anywhere\r\n marketplaceId: 107\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Sears\r\n marketplaceId: 25\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SellBrite\r\n marketplaceId: 82\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SellerActive\r\n marketplaceId: 65\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: ShipEngine API\r\n marketplaceId: 118\r\n canRefresh: false\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: ShipStation\r\n marketplaceId: 0\r\n canRefresh: false\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: Shopify\r\n marketplaceId: 14\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SkuVault\r\n marketplaceId: 60\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Soldsie\r\n marketplaceId: 49\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Sophio\r\n marketplaceId: 39\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Spark Shipping\r\n marketplaceId: 103\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Square\r\n marketplaceId: 70\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Squarespace\r\n marketplaceId: 57\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Stitch Labs\r\n marketplaceId: 26\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Storenvy\r\n marketplaceId: 40\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Stripe\r\n marketplaceId: 95\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: SureDone\r\n marketplaceId: 88\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Tanga\r\n marketplaceId: 96\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Tophatter\r\n marketplaceId: 101\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: topShelf\r\n marketplaceId: 27\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: TradeGecko\r\n marketplaceId: 67\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: UltraCart\r\n marketplaceId: 35\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: VisualSoft\r\n marketplaceId: 133\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Volo\r\n marketplaceId: 129\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Volusion\r\n marketplaceId: 7\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Walmart\r\n marketplaceId: 93\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Weebly\r\n marketplaceId: 97\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Wish\r\n marketplaceId: 48\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Wix\r\n marketplaceId: 119\r\n canRefresh: true\r\n supportsCustomMappings: false\r\n supportsCustomStatuses: false\r\n canConfirmShipments: false\r\n - name: WooCommerce\r\n marketplaceId: 36\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: X-Cart\r\n marketplaceId: 17\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Yahoo\r\n marketplaceId: 24\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n - name: Zen Cart\r\n marketplaceId: 10\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n - name: Zoey\r\n marketplaceId: 84\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: true\r\n canConfirmShipments: true\r\n deprecated: false\r\n parameters: []\r\n //stores/refreshstore:\r\n post:\r\n tags:\r\n - Stores\r\n summary: Refresh Store\r\n description: Initiates a store refresh.\r\n operationId: RefreshStore\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"storeId\": {{storeId}},\r\n \"refreshDate\": \"2021-01-24 15:05:02\"\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"storeId\": {{storeId}},\r\n \"refreshDate\": \"2021-01-24 15:05:02\"\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //stores/getrefreshstatus:\r\n get:\r\n tags:\r\n - Stores\r\n summary: Get Store Refresh status\r\n description: Retrieves the refresh status of a given store.\r\n operationId: GetStoreRefreshstatus\r\n parameters:\r\n - name: storeId\r\n in: query\r\n description: Specifies the store whose status will be retrieved.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: string\r\n examples:\r\n - '{{storeId}}'\r\n responses:\r\n '200':\r\n description: ''\r\n headers: {}\r\n deprecated: false\r\n parameters: []\r\n //users:\r\n get:\r\n tags:\r\n - Users\r\n summary: List Users\r\n operationId: ListUsers\r\n parameters:\r\n - name: showInactive\r\n in: query\r\n description: Determines whether inactive users will be returned in the response.\r\n required: true\r\n style: form\r\n explode: true\r\n schema:\r\n type: boolean\r\n examples:\r\n - false\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:12:01 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDQVBkpAHygIEUMTG1ZKARoDTFZSUgFXCFYUFQUeEVcBA1QACwBcUwNWU1AKCgBGTQRWXUQDOQ==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '59'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '107'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListUser'\r\n description: ''\r\n examples:\r\n - - userId: d52e3087-15dd-412c-a3b5-d66b8ed875c7\r\n userName: admin@gmail.com\r\n name: Divyang Desai\r\n contentMediaType: application/json\r\n example:\r\n - userId: d52e3087-15dd-412c-a3b5-d66b8ed875c7\r\n userName: admin@gmail.com\r\n name: Divyang Desai\r\n deprecated: false\r\n parameters: []\r\n //warehouses/createwarehouse:\r\n post:\r\n tags:\r\n - Warehouses\r\n summary: Create Warehouse\r\n description: Adds a Ship From Location (formerly known as warehouse) to your account.\r\n operationId: CreateWarehouse\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/CreateWarehouseRequest'\r\n - examples:\r\n - warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n returnAddress: null\r\n isDefault: false\r\n contentMediaType: application/json\r\n example:\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n returnAddress: null\r\n isDefault: false\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:14:19 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYHEV1bXxESB0QedBQBUEJWNQcRB1gNTRFdGhgCHVUVUR9RAFpXBAZXSlcIBhxGV1oCBgMCBggAA1pUUVoEVxpOXllYQVY4\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '41'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '726'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/CreateWarehouse'\r\n - examples:\r\n - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n contentMediaType: application/json\r\n example:\r\n warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n deprecated: false\r\n parameters: []\r\n //warehouses:\r\n get:\r\n tags:\r\n - Warehouses\r\n summary: List Warehouses\r\n description: Retrieves a list of your Ship From Locations (formerly known as warehouses).\r\n operationId: ListWarehouses\r\n parameters: []\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:18:24 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYHEV1bXxESB0Qeew8XRRQfUkhTTgBMCFIOAAUGH0gITRNXV1ZWDlQFXgJZCwhdVgMFExsABV1FVj8=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '35'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '728'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/ListWarehouse'\r\n description: ''\r\n examples:\r\n - - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n contentMediaType: application/json\r\n example:\r\n - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n deprecated: false\r\n parameters: []\r\n //warehouses/{warehouseId}:\r\n get:\r\n tags:\r\n - Warehouses\r\n summary: Get Warehouse\r\n description: Returns a list of active Ship From Locations (formerly known as warehouses) on the ShipStation account.\r\n operationId: GetWarehouse\r\n parameters:\r\n - name: warehouseId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:17:02 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYHEV1bXxESB0QecAMQExoDTFZPUh5SCVoMDgEHH0gITRMAAwQGDwYDAlUIUAABUVMBExsABV1FVj8=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '57'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '726'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/GetWarehouse'\r\n - examples:\r\n - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n contentMediaType: application/json\r\n example:\r\n warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n deprecated: false\r\n put:\r\n tags:\r\n - Warehouses\r\n summary: Update Warehouse\r\n description: >-\r\n Updates an existing Ship From Location (formerly known as warehouse). <br/><br/>\r\n\r\n\r\n\r\n If a \"returnAddress\" object is not specified, your \"originAddress\" will be used as your \"returnAddress\".\r\n operationId: UpdateWarehouse\r\n parameters:\r\n - name: warehouseId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n type: string\r\n examples:\r\n - >-\r\n {\r\n \"warehouseId\": {{warehouseId}},\r\n \"warehouseName\": \"API Ship From Location\",\r\n \"originAddress\": {\r\n \"name\": \"API Warehouse\",\r\n \"company\": \"ShipStation\",\r\n \"street1\": \"2815 Exposition Blvd\",\r\n \"street2\": null,\r\n \"street3\": null,\r\n \"city\": \"Austin\",\r\n \"state\": \"TX\",\r\n \"postalCode\": \"78703\",\r\n \"country\": \"US\",\r\n \"phone\": \"512-555-5555\",\r\n \"residential\": true,\r\n \"addressVerified\": null\r\n },\r\n \"returnAddress\": {\r\n \"name\": \"API Ship From Location\",\r\n \"company\": \"ShipStation\",\r\n \"street1\": \"2815 Exposition Blvd\",\r\n \"street2\": null,\r\n \"street3\": null,\r\n \"city\": \"Austin\",\r\n \"state\": \"TX\",\r\n \"postalCode\": \"78703\",\r\n \"country\": \"US\",\r\n \"phone\": \"512-555-5555\",\r\n \"residential\": null,\r\n \"addressVerified\": null\r\n },\r\n \"createDate\": \"2015-07-02T08:38:31.4870000\",\r\n \"isDefault\": true\r\n }\r\n contentMediaType: application/json\r\n example: >-\r\n {\r\n \"warehouseId\": {{warehouseId}},\r\n \"warehouseName\": \"API Ship From Location\",\r\n \"originAddress\": {\r\n \"name\": \"API Warehouse\",\r\n \"company\": \"ShipStation\",\r\n \"street1\": \"2815 Exposition Blvd\",\r\n \"street2\": null,\r\n \"street3\": null,\r\n \"city\": \"Austin\",\r\n \"state\": \"TX\",\r\n \"postalCode\": \"78703\",\r\n \"country\": \"US\",\r\n \"phone\": \"512-555-5555\",\r\n \"residential\": true,\r\n \"addressVerified\": null\r\n },\r\n \"returnAddress\": {\r\n \"name\": \"API Ship From Location\",\r\n \"company\": \"ShipStation\",\r\n \"street1\": \"2815 Exposition Blvd\",\r\n \"street2\": null,\r\n \"street3\": null,\r\n \"city\": \"Austin\",\r\n \"state\": \"TX\",\r\n \"postalCode\": \"78703\",\r\n \"country\": \"US\",\r\n \"phone\": \"512-555-5555\",\r\n \"residential\": null,\r\n \"addressVerified\": null\r\n },\r\n \"createDate\": \"2015-07-02T08:38:31.4870000\",\r\n \"isDefault\": true\r\n }\r\n required: true\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:19:36 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYHEV1bXxESB0QeYhYAUEJWQEpTTABOCEwJCAUKAlUNTQlTAE5GDgNQBFAOUQRQWFEOAABfBhMaVQMKEAdt\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '38'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '24'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '70'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/UpdateWarehouse'\r\n - examples:\r\n - success: true\r\n message: The requested warehouse has been updated.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested warehouse has been updated.\r\n deprecated: false\r\n delete:\r\n tags:\r\n - Warehouses\r\n summary: Delete a warehouse\r\n description: Removes a warehouse from ShipStation's UI.\r\n operationId: Deleteawarehouse\r\n parameters:\r\n - name: warehouseId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 03:07:47 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYHEV1bXxESB0QecwMIVEJWQEpTTABOCEwJCAwGAFwMTRxQH0AGBlZTBAEKUFFVUVZVBwdURh1QUg4VBj8=\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '37'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '12'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '70'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/Deleteawarehouse'\r\n - examples:\r\n - success: true\r\n message: The requested warehouse has been deleted.\r\n contentMediaType: application/json\r\n example:\r\n success: true\r\n message: The requested warehouse has been deleted.\r\n deprecated: false\r\n parameters: []\r\n //webhooks:\r\n get:\r\n tags:\r\n - Webhooks\r\n summary: List Webhooks\r\n description: Retrieves a list of registered webhooks for the account.\r\n operationId: ListWebhooks\r\n parameters: []\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:22:43 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYDAVBcXw8STXtYRBJGHQYdUkpTTABWDlUOCgweHlQVQ1NUVQBSAwYAVlYMVgEHVVQVHVEHCEJTbg==\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '17'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '314'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/ListWebhooks'\r\n - examples:\r\n - webhooks:\r\n - IsLabelAPIHook: false\r\n WebHookID: 3189\r\n SellerID: 2335513\r\n StoreID: null\r\n HookType: ORDER_NOTIFY\r\n MessageFormat: Json\r\n Url: http://someexamplewebhookurl.com/neworder\r\n Name: My Webhook\r\n BulkCopyBatchID: null\r\n BulkCopyRecordID: null\r\n Active: true\r\n WebhookLogs: []\r\n Seller: null\r\n Store: null\r\n contentMediaType: application/json\r\n example:\r\n webhooks:\r\n - IsLabelAPIHook: false\r\n WebHookID: 3189\r\n SellerID: 2335513\r\n StoreID: null\r\n HookType: ORDER_NOTIFY\r\n MessageFormat: Json\r\n Url: http://someexamplewebhookurl.com/neworder\r\n Name: My Webhook\r\n BulkCopyBatchID: null\r\n BulkCopyRecordID: null\r\n Active: true\r\n WebhookLogs: []\r\n Seller: null\r\n Store: null\r\n deprecated: false\r\n parameters: []\r\n //webhooks/subscribe:\r\n post:\r\n tags:\r\n - Webhooks\r\n summary: Subscribe to Webhook\r\n description: Subscribes to a specific type of webhook. If a `store_id` is passed in, the webhooks will only be triggered for that specific `store_id`. The `event` type that is passed in will determine what type of webhooks will be sent.\r\n operationId: SubscribetoWebhook\r\n parameters: []\r\n requestBody:\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/SubscribetoWebhookRequest'\r\n - examples:\r\n - target_url: http://someexamplewebhookurl.com/neworder\r\n event: ORDER_NOTIFY\r\n store_id: null\r\n friendly_name: My Webhook\r\n contentMediaType: application/json\r\n example:\r\n target_url: http://someexamplewebhookurl.com/neworder\r\n event: ORDER_NOTIFY\r\n store_id: null\r\n friendly_name: My Webhook\r\n required: true\r\n responses:\r\n '201':\r\n description: Created\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n content-type:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: application/json; charset=utf-8\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sat, 23 Jan 2021 18:21:49 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYDAVBcXw8STWREVRUHQ19RB0RPUh5SFFIWCAUHBlAPTQBVAE5GAQAABVJdUgkCBwcHB1RWXRMaVQMKEAdt\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '10'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '11'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content:\r\n application/json:\r\n schema:\r\n oneOf:\r\n - $ref: '#/components/schemas/SubscribetoWebhook'\r\n - examples:\r\n - id: 12345\r\n contentMediaType: application/json\r\n example:\r\n id: 12345\r\n deprecated: false\r\n parameters: []\r\n //webhooks/{webhookId}:\r\n delete:\r\n tags:\r\n - Webhooks\r\n summary: Unsubscribe to Webhook\r\n description: Unsubscribes from a certain webhook.\r\n operationId: UnsubscribetoWebhook\r\n parameters:\r\n - name: webhookId\r\n in: path\r\n required: true\r\n style: simple\r\n schema:\r\n type: string\r\n responses:\r\n '200':\r\n description: OK\r\n headers:\r\n cache-control:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n date:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Sun, 24 Jan 2021 03:16:29 GMT\r\n expires:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '-1'\r\n pragma:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: no-cache\r\n server:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: Microsoft-IIS/8.0\r\n x-aspnet-version:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: 4.0.30319\r\n x-newrelic-app-data:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: PxQGVFZXCgITUllUAAcPX1EDFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GDYDAVBcXw8STXNUWwMQVBQfUkhTTgBMCVcADAYFAkkUUB1DAVBXA1VYVFEMAQRcB1BWCBVKAlBaQAc7\r\n x-powered-by:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: ASP.NET\r\n X-Rate-Limit-Limit:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '40'\r\n X-Rate-Limit-Remaining:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '39'\r\n X-Rate-Limit-Reset:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '31'\r\n Content-Length:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: '0'\r\n Connection:\r\n content:\r\n text/plain:\r\n schema:\r\n type: string\r\n contentMediaType: text/plain\r\n example: keep-alive\r\n content: {}\r\n deprecated: false\r\n parameters: []\r\ncomponents:\r\n schemas:\r\n AddfundstocarrieraccountRequest:\r\n title: AddfundstocarrieraccountRequest\r\n required:\r\n - carrierCode\r\n - amount\r\n type: object\r\n properties:\r\n carrierCode:\r\n type: string\r\n amount:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - carrierCode: fedex\r\n amount: 20\r\n GetCarrierByCode:\r\n title: GetCarrierByCode\r\n required:\r\n - name\r\n - code\r\n - accountNumber\r\n - requiresFundedAccount\r\n - balance\r\n - nickname\r\n - shippingProviderId\r\n - primary\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n code:\r\n type: string\r\n accountNumber:\r\n type:\r\n - string\r\n - 'null'\r\n requiresFundedAccount:\r\n type: boolean\r\n balance:\r\n type: integer\r\n contentEncoding: int32\r\n nickname:\r\n type: string\r\n shippingProviderId:\r\n type: integer\r\n contentEncoding: int32\r\n primary:\r\n type: boolean\r\n examples:\r\n - name: Stamps.com\r\n code: stamps_com\r\n accountNumber: null\r\n requiresFundedAccount: true\r\n balance: 0\r\n nickname: Free\r\n shippingProviderId: 150759\r\n primary: true\r\n ListCarrier:\r\n title: ListCarrier\r\n required:\r\n - name\r\n - code\r\n - accountNumber\r\n - requiresFundedAccount\r\n - balance\r\n - nickname\r\n - shippingProviderId\r\n - primary\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n code:\r\n type: string\r\n accountNumber:\r\n type:\r\n - string\r\n - 'null'\r\n requiresFundedAccount:\r\n type: boolean\r\n balance:\r\n type: integer\r\n contentEncoding: int32\r\n nickname:\r\n type: string\r\n shippingProviderId:\r\n type: integer\r\n contentEncoding: int32\r\n primary:\r\n type: boolean\r\n examples:\r\n - name: Stamps.com\r\n code: stamps_com\r\n accountNumber: null\r\n requiresFundedAccount: true\r\n balance: 0\r\n nickname: Free\r\n shippingProviderId: 150759\r\n primary: true\r\n ListPackage:\r\n title: ListPackage\r\n required:\r\n - carrierCode\r\n - code\r\n - name\r\n - domestic\r\n - international\r\n type: object\r\n properties:\r\n carrierCode:\r\n type: string\r\n code:\r\n type: string\r\n name:\r\n type: string\r\n domestic:\r\n type: boolean\r\n international:\r\n type: boolean\r\n examples:\r\n - carrierCode: stamps_com\r\n code: package\r\n name: Package\r\n domestic: true\r\n international: true\r\n ListService:\r\n title: ListService\r\n required:\r\n - carrierCode\r\n - code\r\n - name\r\n - domestic\r\n - international\r\n type: object\r\n properties:\r\n carrierCode:\r\n type: string\r\n code:\r\n type: string\r\n name:\r\n type: string\r\n domestic:\r\n type: boolean\r\n international:\r\n type: boolean\r\n examples:\r\n - carrierCode: stamps_com\r\n code: usps_first_class_mail\r\n name: USPS First Class Mail\r\n domestic: true\r\n international: false\r\n ListCustomers:\r\n title: ListCustomers\r\n required:\r\n - customers\r\n - total\r\n - page\r\n - pages\r\n type: object\r\n properties:\r\n customers:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Customer'\r\n total:\r\n type: integer\r\n contentEncoding: int32\r\n page:\r\n type: integer\r\n contentEncoding: int32\r\n pages:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - customers:\r\n - customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n - customerId: 12923112\r\n createDate: 2021-01-23T06:40:15.0170000\r\n modifyDate: 2021-01-23T06:40:15.0170000\r\n name: John Peters\r\n company: Sample Company\r\n street1: 123 Street\r\n street2: ''\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n countryCode: US\r\n phone: (512) 555-5555\r\n email: john@samplecompany.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744167\r\n customerId: 12923112\r\n createDate: 2021-01-23T06:40:15.0170000\r\n modifyDate: 2021-01-23T06:40:15.0170000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: john.peters\r\n tags: null\r\n total: 2\r\n page: 1\r\n pages: 1\r\n Customer:\r\n title: Customer\r\n required:\r\n - customerId\r\n - createDate\r\n - modifyDate\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - city\r\n - state\r\n - postalCode\r\n - countryCode\r\n - phone\r\n - email\r\n - addressVerified\r\n - marketplaceUsernames\r\n - tags\r\n type: object\r\n properties:\r\n customerId:\r\n type: integer\r\n contentEncoding: int32\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type: string\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n countryCode:\r\n type: string\r\n phone:\r\n type: string\r\n email:\r\n type: string\r\n addressVerified:\r\n type: string\r\n marketplaceUsernames:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/MarketplaceUsername'\r\n tags:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n MarketplaceUsername:\r\n title: MarketplaceUsername\r\n required:\r\n - customerUserId\r\n - customerId\r\n - createDate\r\n - modifyDate\r\n - marketplaceId\r\n - marketplace\r\n - username\r\n type: object\r\n properties:\r\n customerUserId:\r\n type: integer\r\n contentEncoding: int32\r\n customerId:\r\n type: integer\r\n contentEncoding: int32\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n marketplaceId:\r\n type: integer\r\n contentEncoding: int32\r\n marketplace:\r\n type: string\r\n username:\r\n type: string\r\n examples:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n GetCustomer:\r\n title: GetCustomer\r\n required:\r\n - customerId\r\n - createDate\r\n - modifyDate\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - city\r\n - state\r\n - postalCode\r\n - countryCode\r\n - phone\r\n - email\r\n - addressVerified\r\n - marketplaceUsernames\r\n - tags\r\n type: object\r\n properties:\r\n customerId:\r\n type: integer\r\n contentEncoding: int32\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type: string\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n countryCode:\r\n type: string\r\n phone:\r\n type: string\r\n email:\r\n type: string\r\n addressVerified:\r\n type: string\r\n marketplaceUsernames:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/MarketplaceUsername'\r\n tags:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n name: Jane Thompson\r\n company: Test Company\r\n street1: 456 Road\r\n street2: Suite 2\r\n city: Austin\r\n state: TX\r\n postalCode: '78652'\r\n countryCode: US\r\n phone: (512) 555-5556\r\n email: jane@test.com\r\n addressVerified: Unverified\r\n marketplaceUsernames:\r\n - customerUserId: 12744168\r\n customerId: 12923113\r\n createDate: 2021-01-23T06:40:15.0500000\r\n modifyDate: 2021-01-23T06:40:15.0500000\r\n marketplaceId: 0\r\n marketplace: ShipStation\r\n username: janethompson\r\n tags: null\r\n CreateUpdateOrder:\r\n title: CreateUpdateOrder\r\n required:\r\n - orderId\r\n - orderNumber\r\n - orderKey\r\n - orderDate\r\n - createDate\r\n - modifyDate\r\n - paymentDate\r\n - shipByDate\r\n - orderStatus\r\n - customerId\r\n - customerUsername\r\n - customerEmail\r\n - billTo\r\n - shipTo\r\n - items\r\n - orderTotal\r\n - amountPaid\r\n - taxAmount\r\n - shippingAmount\r\n - customerNotes\r\n - internalNotes\r\n - gift\r\n - giftMessage\r\n - paymentMethod\r\n - requestedShippingService\r\n - carrierCode\r\n - serviceCode\r\n - packageCode\r\n - confirmation\r\n - shipDate\r\n - holdUntilDate\r\n - weight\r\n - dimensions\r\n - insuranceOptions\r\n - internationalOptions\r\n - advancedOptions\r\n - tagIds\r\n - userId\r\n - externallyFulfilled\r\n - externallyFulfilledBy\r\n - labelMessages\r\n type: object\r\n properties:\r\n orderId:\r\n type: integer\r\n contentEncoding: int32\r\n orderNumber:\r\n type: string\r\n orderKey:\r\n type: string\r\n orderDate:\r\n type: string\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n paymentDate:\r\n type: string\r\n shipByDate:\r\n type: string\r\n orderStatus:\r\n type: string\r\n customerId:\r\n type: integer\r\n contentEncoding: int32\r\n customerUsername:\r\n type: string\r\n customerEmail:\r\n type: string\r\n billTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/BillTo'\r\n - {}\r\n shipTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/ShipTo'\r\n - {}\r\n items:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Item'\r\n orderTotal:\r\n type: number\r\n amountPaid:\r\n type: number\r\n taxAmount:\r\n type: integer\r\n contentEncoding: int32\r\n shippingAmount:\r\n type: integer\r\n contentEncoding: int32\r\n customerNotes:\r\n type: string\r\n internalNotes:\r\n type: string\r\n gift:\r\n type: boolean\r\n giftMessage:\r\n type: string\r\n paymentMethod:\r\n type: string\r\n requestedShippingService:\r\n type: string\r\n carrierCode:\r\n type: string\r\n serviceCode:\r\n type: string\r\n packageCode:\r\n type: string\r\n confirmation:\r\n type: string\r\n shipDate:\r\n type: string\r\n holdUntilDate:\r\n type:\r\n - string\r\n - 'null'\r\n weight:\r\n oneOf:\r\n - $ref: '#/components/schemas/Weight'\r\n - {}\r\n dimensions:\r\n oneOf:\r\n - $ref: '#/components/schemas/Dimensions'\r\n - {}\r\n insuranceOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/InsuranceOptions'\r\n - {}\r\n internationalOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/InternationalOptions'\r\n - {}\r\n advancedOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/AdvancedOptions'\r\n - {}\r\n tagIds:\r\n type:\r\n - string\r\n - 'null'\r\n userId:\r\n type:\r\n - string\r\n - 'null'\r\n externallyFulfilled:\r\n type: boolean\r\n externallyFulfilledBy:\r\n type:\r\n - string\r\n - 'null'\r\n labelMessages:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T09:09:08.4000000\r\n modifyDate: 2021-01-23T09:19:48.6130000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12934379\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32208850\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n - orderItemId: 32208851\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: delivery\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 25\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: null\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n BillTo:\r\n title: BillTo\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n - addressVerified\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type:\r\n - string\r\n - 'null'\r\n street1:\r\n type:\r\n - string\r\n - 'null'\r\n street2:\r\n type:\r\n - string\r\n - 'null'\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type:\r\n - string\r\n - 'null'\r\n state:\r\n type:\r\n - string\r\n - 'null'\r\n postalCode:\r\n type:\r\n - string\r\n - 'null'\r\n country:\r\n type:\r\n - string\r\n - 'null'\r\n phone:\r\n type:\r\n - string\r\n - 'null'\r\n residential:\r\n type:\r\n - string\r\n - 'null'\r\n addressVerified:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n ShipTo:\r\n title: ShipTo\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n - addressVerified\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type: string\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n country:\r\n type: string\r\n phone:\r\n type: string\r\n residential:\r\n type: boolean\r\n addressVerified:\r\n type: string\r\n examples:\r\n - name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n Item:\r\n title: Item\r\n required:\r\n - orderItemId\r\n - lineItemKey\r\n - sku\r\n - name\r\n - imageUrl\r\n - weight\r\n - quantity\r\n - unitPrice\r\n - taxAmount\r\n - shippingAmount\r\n - warehouseLocation\r\n - options\r\n - productId\r\n - fulfillmentSku\r\n - adjustment\r\n - upc\r\n - createDate\r\n - modifyDate\r\n type: object\r\n properties:\r\n orderItemId:\r\n type: integer\r\n contentEncoding: int32\r\n lineItemKey:\r\n type:\r\n - string\r\n - 'null'\r\n sku:\r\n type: string\r\n name:\r\n type: string\r\n imageUrl:\r\n type:\r\n - string\r\n - 'null'\r\n weight:\r\n oneOf:\r\n - $ref: '#/components/schemas/Weight'\r\n - {}\r\n quantity:\r\n type: integer\r\n contentEncoding: int32\r\n unitPrice:\r\n type: number\r\n taxAmount:\r\n oneOf:\r\n - type:\r\n - number\r\n - 'null'\r\n - type:\r\n - string\r\n - 'null'\r\n - {}\r\n shippingAmount:\r\n oneOf:\r\n - type:\r\n - integer\r\n - 'null'\r\n contentEncoding: int32\r\n - type:\r\n - string\r\n - 'null'\r\n - {}\r\n warehouseLocation:\r\n type:\r\n - string\r\n - 'null'\r\n options:\r\n type: array\r\n items:\r\n oneOf:\r\n - oneOf:\r\n - $ref: '#/components/schemas/Option'\r\n - examples:\r\n - name: Size\r\n value: Large\r\n - type: string\r\n productId:\r\n oneOf:\r\n - type:\r\n - integer\r\n - 'null'\r\n contentEncoding: int32\r\n - type:\r\n - string\r\n - 'null'\r\n - {}\r\n fulfillmentSku:\r\n type:\r\n - string\r\n - 'null'\r\n adjustment:\r\n type: boolean\r\n upc:\r\n type:\r\n - string\r\n - 'null'\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n examples:\r\n - orderItemId: 32208850\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T09:09:08.32\r\n modifyDate: 2021-01-23T09:09:08.32\r\n Weight:\r\n title: Weight\r\n required:\r\n - value\r\n - units\r\n - WeightUnits\r\n type: object\r\n properties:\r\n value:\r\n type: integer\r\n contentEncoding: int32\r\n units:\r\n type: string\r\n WeightUnits:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n Option:\r\n title: Option\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n value:\r\n type: string\r\n examples:\r\n - name: Size\r\n value: Large\r\n Dimensions:\r\n title: Dimensions\r\n required:\r\n - units\r\n - length\r\n - width\r\n - height\r\n type: object\r\n properties:\r\n units:\r\n type: string\r\n length:\r\n type: integer\r\n contentEncoding: int32\r\n width:\r\n type: integer\r\n contentEncoding: int32\r\n height:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n InsuranceOptions:\r\n title: InsuranceOptions\r\n required:\r\n - provider\r\n - insureShipment\r\n - insuredValue\r\n type: object\r\n properties:\r\n provider:\r\n type: string\r\n insureShipment:\r\n type: boolean\r\n insuredValue:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n InternationalOptions:\r\n title: InternationalOptions\r\n required:\r\n - contents\r\n - customsItems\r\n - nonDelivery\r\n type: object\r\n properties:\r\n contents:\r\n type:\r\n - string\r\n - 'null'\r\n customsItems:\r\n type:\r\n - string\r\n - 'null'\r\n nonDelivery:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n AdvancedOptions:\r\n title: AdvancedOptions\r\n required:\r\n - warehouseId\r\n - nonMachinable\r\n - saturdayDelivery\r\n - containsAlcohol\r\n - mergedOrSplit\r\n - mergedIds\r\n - parentId\r\n - storeId\r\n - customField1\r\n - customField2\r\n - customField3\r\n - source\r\n - billToParty\r\n - billToAccount\r\n - billToPostalCode\r\n - billToCountryCode\r\n - billToMyOtherAccount\r\n type: object\r\n properties:\r\n warehouseId:\r\n type:\r\n - string\r\n - 'null'\r\n nonMachinable:\r\n type: boolean\r\n saturdayDelivery:\r\n type: boolean\r\n containsAlcohol:\r\n type: boolean\r\n mergedOrSplit:\r\n type: boolean\r\n mergedIds:\r\n type: array\r\n items:\r\n type: string\r\n parentId:\r\n type:\r\n - string\r\n - 'null'\r\n storeId:\r\n type: integer\r\n contentEncoding: int32\r\n customField1:\r\n type: string\r\n customField2:\r\n type: string\r\n customField3:\r\n type: string\r\n source:\r\n type: string\r\n billToParty:\r\n type:\r\n - string\r\n - 'null'\r\n billToAccount:\r\n type:\r\n - string\r\n - 'null'\r\n billToPostalCode:\r\n type:\r\n - string\r\n - 'null'\r\n billToCountryCode:\r\n type:\r\n - string\r\n - 'null'\r\n billToMyOtherAccount:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - warehouseId: null\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n CreateUpdateMultipleOrders:\r\n title: CreateUpdateMultipleOrders\r\n required:\r\n - hasErrors\r\n - results\r\n type: object\r\n properties:\r\n hasErrors:\r\n type: boolean\r\n results:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Result'\r\n examples:\r\n - hasErrors: false\r\n results:\r\n - orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n success: true\r\n errorMessage: null\r\n Result:\r\n title: Result\r\n required:\r\n - orderId\r\n - orderNumber\r\n - orderKey\r\n - success\r\n - errorMessage\r\n type: object\r\n properties:\r\n orderId:\r\n type: integer\r\n contentEncoding: int32\r\n orderNumber:\r\n type: string\r\n orderKey:\r\n type: string\r\n success:\r\n type: boolean\r\n errorMessage:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - orderId: 21466104\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0f6bec18-3e89-4881-83aa-f392d84f4c74\r\n success: true\r\n errorMessage: null\r\n AssignUserToOrderRequest:\r\n title: AssignUserToOrderRequest\r\n required:\r\n - orderIds\r\n - userId\r\n type: object\r\n properties:\r\n orderIds:\r\n type: array\r\n items:\r\n type: integer\r\n contentEncoding: int32\r\n userId:\r\n type: string\r\n examples:\r\n - orderIds:\r\n - 123456789\r\n - 12345679\r\n userId: 123456AB-ab12-3c4d-5e67-89f1abc1defa\r\n AddTagToOrder:\r\n title: AddTagToOrder\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: Tag added successfully.\r\n ListOrders:\r\n title: ListOrders\r\n required:\r\n - orders\r\n - total\r\n - page\r\n - pages\r\n type: object\r\n properties:\r\n orders:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Order'\r\n total:\r\n type: integer\r\n contentEncoding: int32\r\n page:\r\n type: integer\r\n contentEncoding: int32\r\n pages:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - orders:\r\n - orderId: 21533276\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0d6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:12:33.7400000\r\n modifyDate: 2021-01-23T17:12:52.1970000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318261\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n - orderItemId: 32318262\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n - orderId: 21533759\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: b0a0422e-af18-4ff6-a9d4-ceb4d010947c\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:15:54.7530000\r\n modifyDate: 2021-01-23T17:16:13.2900000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318921\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:15:54.66\r\n modifyDate: 2021-01-23T17:15:54.66\r\n - orderItemId: 32318922\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:15:54.66\r\n modifyDate: 2021-01-23T17:15:54.66\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 246f6803-5081-48bf-b134-1bd5fc74b760\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:16:41.3570000\r\n modifyDate: 2021-01-23T17:16:59.9300000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32319106\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n - orderItemId: 32319107\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2021-04-03\r\n holdUntilDate: null\r\n weight:\r\n value: 32\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n total: 3\r\n page: 1\r\n pages: 1\r\n Order:\r\n title: Order\r\n required:\r\n - orderId\r\n - orderNumber\r\n - orderKey\r\n - orderDate\r\n - createDate\r\n - modifyDate\r\n - paymentDate\r\n - shipByDate\r\n - orderStatus\r\n - customerId\r\n - customerUsername\r\n - customerEmail\r\n - billTo\r\n - shipTo\r\n - items\r\n - orderTotal\r\n - amountPaid\r\n - taxAmount\r\n - shippingAmount\r\n - customerNotes\r\n - internalNotes\r\n - gift\r\n - giftMessage\r\n - paymentMethod\r\n - requestedShippingService\r\n - carrierCode\r\n - serviceCode\r\n - packageCode\r\n - confirmation\r\n - shipDate\r\n - holdUntilDate\r\n - weight\r\n - dimensions\r\n - insuranceOptions\r\n - internationalOptions\r\n - advancedOptions\r\n - tagIds\r\n - userId\r\n - externallyFulfilled\r\n - externallyFulfilledBy\r\n - labelMessages\r\n type: object\r\n properties:\r\n orderId:\r\n type: integer\r\n contentEncoding: int32\r\n orderNumber:\r\n type: string\r\n orderKey:\r\n type: string\r\n orderDate:\r\n type: string\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n paymentDate:\r\n type: string\r\n shipByDate:\r\n type: string\r\n orderStatus:\r\n type: string\r\n customerId:\r\n type: integer\r\n contentEncoding: int32\r\n customerUsername:\r\n type: string\r\n customerEmail:\r\n type: string\r\n billTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/BillTo'\r\n - {}\r\n shipTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/ShipTo'\r\n - {}\r\n items:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Item'\r\n orderTotal:\r\n type: number\r\n amountPaid:\r\n type: number\r\n taxAmount:\r\n type: integer\r\n contentEncoding: int32\r\n shippingAmount:\r\n type: integer\r\n contentEncoding: int32\r\n customerNotes:\r\n type: string\r\n internalNotes:\r\n type: string\r\n gift:\r\n type: boolean\r\n giftMessage:\r\n type: string\r\n paymentMethod:\r\n type: string\r\n requestedShippingService:\r\n type: string\r\n carrierCode:\r\n type: string\r\n serviceCode:\r\n type: string\r\n packageCode:\r\n type: string\r\n confirmation:\r\n type: string\r\n shipDate:\r\n type: string\r\n holdUntilDate:\r\n type:\r\n - string\r\n - 'null'\r\n weight:\r\n oneOf:\r\n - $ref: '#/components/schemas/Weight'\r\n - {}\r\n dimensions:\r\n oneOf:\r\n - $ref: '#/components/schemas/Dimensions'\r\n - {}\r\n insuranceOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/InsuranceOptions'\r\n - {}\r\n internationalOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/InternationalOptions'\r\n - {}\r\n advancedOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/AdvancedOptions1'\r\n - {}\r\n tagIds:\r\n type:\r\n - string\r\n - 'null'\r\n userId:\r\n type:\r\n - string\r\n - 'null'\r\n externallyFulfilled:\r\n type: boolean\r\n externallyFulfilledBy:\r\n type:\r\n - string\r\n - 'null'\r\n labelMessages:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - orderId: 21533276\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 0d6bec18-3e89-4881-83aa-f392d84f4c74\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:12:33.7400000\r\n modifyDate: 2021-01-23T17:12:52.1970000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32318261\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n - orderItemId: 32318262\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:12:33.663\r\n modifyDate: 2021-01-23T17:12:33.663\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2015-07-02\r\n holdUntilDate: null\r\n weight:\r\n value: 48\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n AdvancedOptions1:\r\n title: AdvancedOptions1\r\n required:\r\n - warehouseId\r\n - nonMachinable\r\n - saturdayDelivery\r\n - containsAlcohol\r\n - mergedOrSplit\r\n - mergedIds\r\n - parentId\r\n - storeId\r\n - customField1\r\n - customField2\r\n - customField3\r\n - source\r\n - billToParty\r\n - billToAccount\r\n - billToPostalCode\r\n - billToCountryCode\r\n - billToMyOtherAccount\r\n type: object\r\n properties:\r\n warehouseId:\r\n type: integer\r\n contentEncoding: int32\r\n nonMachinable:\r\n type: boolean\r\n saturdayDelivery:\r\n type: boolean\r\n containsAlcohol:\r\n type: boolean\r\n mergedOrSplit:\r\n type: boolean\r\n mergedIds:\r\n type: array\r\n items:\r\n type: string\r\n parentId:\r\n type:\r\n - string\r\n - 'null'\r\n storeId:\r\n type: integer\r\n contentEncoding: int32\r\n customField1:\r\n type: string\r\n customField2:\r\n type: string\r\n customField3:\r\n type: string\r\n source:\r\n type: string\r\n billToParty:\r\n type:\r\n - string\r\n - 'null'\r\n billToAccount:\r\n type:\r\n - string\r\n - 'null'\r\n billToPostalCode:\r\n type:\r\n - string\r\n - 'null'\r\n billToCountryCode:\r\n type:\r\n - string\r\n - 'null'\r\n billToMyOtherAccount:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n GetOrder:\r\n title: GetOrder\r\n required:\r\n - orderId\r\n - orderNumber\r\n - orderKey\r\n - orderDate\r\n - createDate\r\n - modifyDate\r\n - paymentDate\r\n - shipByDate\r\n - orderStatus\r\n - customerId\r\n - customerUsername\r\n - customerEmail\r\n - billTo\r\n - shipTo\r\n - items\r\n - orderTotal\r\n - amountPaid\r\n - taxAmount\r\n - shippingAmount\r\n - customerNotes\r\n - internalNotes\r\n - gift\r\n - giftMessage\r\n - paymentMethod\r\n - requestedShippingService\r\n - carrierCode\r\n - serviceCode\r\n - packageCode\r\n - confirmation\r\n - shipDate\r\n - holdUntilDate\r\n - weight\r\n - dimensions\r\n - insuranceOptions\r\n - internationalOptions\r\n - advancedOptions\r\n - tagIds\r\n - userId\r\n - externallyFulfilled\r\n - externallyFulfilledBy\r\n - labelMessages\r\n type: object\r\n properties:\r\n orderId:\r\n type: integer\r\n contentEncoding: int32\r\n orderNumber:\r\n type: string\r\n orderKey:\r\n type: string\r\n orderDate:\r\n type: string\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n paymentDate:\r\n type: string\r\n shipByDate:\r\n type: string\r\n orderStatus:\r\n type: string\r\n customerId:\r\n type: integer\r\n contentEncoding: int32\r\n customerUsername:\r\n type: string\r\n customerEmail:\r\n type: string\r\n billTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/BillTo'\r\n - {}\r\n shipTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/ShipTo'\r\n - {}\r\n items:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Item'\r\n orderTotal:\r\n type: number\r\n amountPaid:\r\n type: number\r\n taxAmount:\r\n type: integer\r\n contentEncoding: int32\r\n shippingAmount:\r\n type: integer\r\n contentEncoding: int32\r\n customerNotes:\r\n type: string\r\n internalNotes:\r\n type: string\r\n gift:\r\n type: boolean\r\n giftMessage:\r\n type: string\r\n paymentMethod:\r\n type: string\r\n requestedShippingService:\r\n type: string\r\n carrierCode:\r\n type: string\r\n serviceCode:\r\n type: string\r\n packageCode:\r\n type: string\r\n confirmation:\r\n type: string\r\n shipDate:\r\n type: string\r\n holdUntilDate:\r\n type:\r\n - string\r\n - 'null'\r\n weight:\r\n oneOf:\r\n - $ref: '#/components/schemas/Weight'\r\n - {}\r\n dimensions:\r\n oneOf:\r\n - $ref: '#/components/schemas/Dimensions'\r\n - {}\r\n insuranceOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/InsuranceOptions'\r\n - {}\r\n internationalOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/InternationalOptions'\r\n - {}\r\n advancedOptions:\r\n oneOf:\r\n - $ref: '#/components/schemas/AdvancedOptions1'\r\n - {}\r\n tagIds:\r\n type:\r\n - string\r\n - 'null'\r\n userId:\r\n type:\r\n - string\r\n - 'null'\r\n externallyFulfilled:\r\n type: boolean\r\n externallyFulfilledBy:\r\n type:\r\n - string\r\n - 'null'\r\n labelMessages:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n orderKey: 246f6803-5081-48bf-b134-1bd5fc74b760\r\n orderDate: 2015-06-29T08:46:27.0000000\r\n createDate: 2021-01-23T17:16:41.3570000\r\n modifyDate: 2021-01-23T17:16:59.9300000\r\n paymentDate: 2015-06-29T08:46:27.0000000\r\n shipByDate: 2015-07-05T00:00:00.0000000\r\n orderStatus: awaiting_shipment\r\n customerId: 12982568\r\n customerUsername: john.smith@gmail.com\r\n customerEmail: john.smith@gmail.com\r\n billTo:\r\n name: The President\r\n company: null\r\n street1: null\r\n street2: null\r\n street3: null\r\n city: null\r\n state: null\r\n postalCode: null\r\n country: null\r\n phone: null\r\n residential: null\r\n addressVerified: null\r\n shipTo:\r\n name: The President\r\n company: US GOVT\r\n street1: 1600 PENNSYLVANIA AVE NW\r\n street2: OVAL OFFICE\r\n street3: null\r\n city: WASHINGTON\r\n state: DC\r\n postalCode: 20500-0005\r\n country: US\r\n phone: 555-555-5555\r\n residential: false\r\n addressVerified: Address validated successfully\r\n items:\r\n - orderItemId: 32319106\r\n lineItemKey: vd08-MSLbtx\r\n sku: ABC123\r\n name: 'Test item #1'\r\n imageUrl: null\r\n weight:\r\n value: 24\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 2\r\n unitPrice: 99.99\r\n taxAmount: 2.5\r\n shippingAmount: 5\r\n warehouseLocation: Aisle 1, Bin 7\r\n options:\r\n - name: Size\r\n value: Large\r\n productId: 3691668\r\n fulfillmentSku: null\r\n adjustment: false\r\n upc: 32-65-98\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n - orderItemId: 32319107\r\n lineItemKey: null\r\n sku: DISCOUNT CODE\r\n name: 10% OFF\r\n imageUrl: null\r\n weight:\r\n value: 0\r\n units: ounces\r\n WeightUnits: 1\r\n quantity: 1\r\n unitPrice: -20.55\r\n taxAmount: null\r\n shippingAmount: null\r\n warehouseLocation: null\r\n options: []\r\n productId: null\r\n fulfillmentSku: SKU-Discount\r\n adjustment: true\r\n upc: null\r\n createDate: 2021-01-23T17:16:41.28\r\n modifyDate: 2021-01-23T17:16:41.28\r\n orderTotal: 194.43\r\n amountPaid: 218.73\r\n taxAmount: 5\r\n shippingAmount: 10\r\n customerNotes: Please ship as soon as possible!\r\n internalNotes: Customer called and would like to upgrade shipping\r\n gift: true\r\n giftMessage: Thank you!\r\n paymentMethod: Credit Card\r\n requestedShippingService: Priority Mail\r\n carrierCode: fedex\r\n serviceCode: fedex_2day\r\n packageCode: package\r\n confirmation: none\r\n shipDate: 2021-04-03\r\n holdUntilDate: null\r\n weight:\r\n value: 32\r\n units: ounces\r\n WeightUnits: 1\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n insuranceOptions:\r\n provider: carrier\r\n insureShipment: true\r\n insuredValue: 200\r\n internationalOptions:\r\n contents: null\r\n customsItems: null\r\n nonDelivery: null\r\n advancedOptions:\r\n warehouseId: 511543\r\n nonMachinable: false\r\n saturdayDelivery: false\r\n containsAlcohol: false\r\n mergedOrSplit: false\r\n mergedIds: []\r\n parentId: null\r\n storeId: 179188\r\n customField1: 'Custom data that you can add to an order. See Custom Field #2 & #3 for more info!'\r\n customField2: Per UI settings, this information can appear on some carrier's shipping labels. See link below\r\n customField3: https://help.shipstation.com/hc/en-us/articles/206639957\r\n source: Webstore\r\n billToParty: null\r\n billToAccount: null\r\n billToPostalCode: null\r\n billToCountryCode: null\r\n billToMyOtherAccount: null\r\n tagIds: null\r\n userId: null\r\n externallyFulfilled: false\r\n externallyFulfilledBy: null\r\n labelMessages: null\r\n HoldOrderUntil:\r\n title: HoldOrderUntil\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: Order held successfully.\r\n DeleteOrder:\r\n title: DeleteOrder\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested order has been deleted.\r\n MarkanOrderasShipped:\r\n title: MarkanOrderasShipped\r\n required:\r\n - orderId\r\n - orderNumber\r\n type: object\r\n properties:\r\n orderId:\r\n type: integer\r\n contentEncoding: int32\r\n orderNumber:\r\n type: string\r\n examples:\r\n - orderId: 21533895\r\n orderNumber: TEST-ORDER-API-DOCS\r\n RemoveTagfromOrder:\r\n title: RemoveTagfromOrder\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: Tag removed successfully.\r\n RestoreOrderfromOnHold:\r\n title: RestoreOrderfromOnHold\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested order has been restored\r\n UnassignUserfromOrderRequest:\r\n title: UnassignUserfromOrderRequest\r\n required:\r\n - orderIds\r\n type: object\r\n properties:\r\n orderIds:\r\n type: array\r\n items:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - orderIds:\r\n - 123456789\r\n - 12345679\r\n GetaProduct:\r\n title: GetaProduct\r\n required:\r\n - aliases\r\n - productId\r\n - sku\r\n - name\r\n - price\r\n - defaultCost\r\n - length\r\n - width\r\n - height\r\n - weightOz\r\n - internalNotes\r\n - fulfillmentSku\r\n - createDate\r\n - modifyDate\r\n - active\r\n - productCategory\r\n - productType\r\n - warehouseLocation\r\n - defaultCarrierCode\r\n - defaultServiceCode\r\n - defaultPackageCode\r\n - defaultIntlCarrierCode\r\n - defaultIntlServiceCode\r\n - defaultIntlPackageCode\r\n - defaultConfirmation\r\n - defaultIntlConfirmation\r\n - customsDescription\r\n - customsValue\r\n - customsTariffNo\r\n - customsCountryCode\r\n - noCustoms\r\n - tags\r\n type: object\r\n properties:\r\n aliases:\r\n type:\r\n - string\r\n - 'null'\r\n productId:\r\n type: integer\r\n contentEncoding: int32\r\n sku:\r\n type: string\r\n name:\r\n type: string\r\n price:\r\n type: number\r\n defaultCost:\r\n type:\r\n - string\r\n - 'null'\r\n length:\r\n type:\r\n - string\r\n - 'null'\r\n width:\r\n type:\r\n - string\r\n - 'null'\r\n height:\r\n type:\r\n - string\r\n - 'null'\r\n weightOz:\r\n type:\r\n - string\r\n - 'null'\r\n internalNotes:\r\n type:\r\n - string\r\n - 'null'\r\n fulfillmentSku:\r\n type:\r\n - string\r\n - 'null'\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type:\r\n - string\r\n - 'null'\r\n active:\r\n type: boolean\r\n productCategory:\r\n type:\r\n - string\r\n - 'null'\r\n productType:\r\n type:\r\n - string\r\n - 'null'\r\n warehouseLocation:\r\n type:\r\n - string\r\n - 'null'\r\n defaultCarrierCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultServiceCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultPackageCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlCarrierCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlServiceCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlPackageCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultConfirmation:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlConfirmation:\r\n type:\r\n - string\r\n - 'null'\r\n customsDescription:\r\n type:\r\n - string\r\n - 'null'\r\n customsValue:\r\n type:\r\n - string\r\n - 'null'\r\n customsTariffNo:\r\n type:\r\n - string\r\n - 'null'\r\n customsCountryCode:\r\n type:\r\n - string\r\n - 'null'\r\n noCustoms:\r\n type:\r\n - string\r\n - 'null'\r\n tags:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n ListProducts:\r\n title: ListProducts\r\n required:\r\n - products\r\n - total\r\n - page\r\n - pages\r\n type: object\r\n properties:\r\n products:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Product'\r\n total:\r\n type: integer\r\n contentEncoding: int32\r\n page:\r\n type: integer\r\n contentEncoding: int32\r\n pages:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - products:\r\n - aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n total: 1\r\n page: 1\r\n pages: 0\r\n Product:\r\n title: Product\r\n required:\r\n - aliases\r\n - productId\r\n - sku\r\n - name\r\n - price\r\n - defaultCost\r\n - length\r\n - width\r\n - height\r\n - weightOz\r\n - internalNotes\r\n - fulfillmentSku\r\n - createDate\r\n - modifyDate\r\n - active\r\n - productCategory\r\n - productType\r\n - warehouseLocation\r\n - defaultCarrierCode\r\n - defaultServiceCode\r\n - defaultPackageCode\r\n - defaultIntlCarrierCode\r\n - defaultIntlServiceCode\r\n - defaultIntlPackageCode\r\n - defaultConfirmation\r\n - defaultIntlConfirmation\r\n - customsDescription\r\n - customsValue\r\n - customsTariffNo\r\n - customsCountryCode\r\n - noCustoms\r\n - tags\r\n type: object\r\n properties:\r\n aliases:\r\n type:\r\n - string\r\n - 'null'\r\n productId:\r\n type: integer\r\n contentEncoding: int32\r\n sku:\r\n type: string\r\n name:\r\n type: string\r\n price:\r\n type: number\r\n defaultCost:\r\n type:\r\n - string\r\n - 'null'\r\n length:\r\n type:\r\n - string\r\n - 'null'\r\n width:\r\n type:\r\n - string\r\n - 'null'\r\n height:\r\n type:\r\n - string\r\n - 'null'\r\n weightOz:\r\n type:\r\n - string\r\n - 'null'\r\n internalNotes:\r\n type:\r\n - string\r\n - 'null'\r\n fulfillmentSku:\r\n type:\r\n - string\r\n - 'null'\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type:\r\n - string\r\n - 'null'\r\n active:\r\n type: boolean\r\n productCategory:\r\n type:\r\n - string\r\n - 'null'\r\n productType:\r\n type:\r\n - string\r\n - 'null'\r\n warehouseLocation:\r\n type:\r\n - string\r\n - 'null'\r\n defaultCarrierCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultServiceCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultPackageCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlCarrierCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlServiceCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlPackageCode:\r\n type:\r\n - string\r\n - 'null'\r\n defaultConfirmation:\r\n type:\r\n - string\r\n - 'null'\r\n defaultIntlConfirmation:\r\n type:\r\n - string\r\n - 'null'\r\n customsDescription:\r\n type:\r\n - string\r\n - 'null'\r\n customsValue:\r\n type:\r\n - string\r\n - 'null'\r\n customsTariffNo:\r\n type:\r\n - string\r\n - 'null'\r\n customsCountryCode:\r\n type:\r\n - string\r\n - 'null'\r\n noCustoms:\r\n type:\r\n - string\r\n - 'null'\r\n tags:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - aliases: null\r\n productId: 3691668\r\n sku: ABC123\r\n name: 'Test item #1'\r\n price: 99.99\r\n defaultCost: null\r\n length: null\r\n width: null\r\n height: null\r\n weightOz: null\r\n internalNotes: null\r\n fulfillmentSku: null\r\n createDate: 2021-01-23T09:09:25.793\r\n modifyDate: null\r\n active: true\r\n productCategory: null\r\n productType: null\r\n warehouseLocation: null\r\n defaultCarrierCode: null\r\n defaultServiceCode: null\r\n defaultPackageCode: null\r\n defaultIntlCarrierCode: null\r\n defaultIntlServiceCode: null\r\n defaultIntlPackageCode: null\r\n defaultConfirmation: null\r\n defaultIntlConfirmation: null\r\n customsDescription: null\r\n customsValue: null\r\n customsTariffNo: null\r\n customsCountryCode: null\r\n noCustoms: null\r\n tags: null\r\n UpdateaProduct:\r\n title: UpdateaProduct\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested product has been updated\r\n CreateShipmentLabelRequest:\r\n title: CreateShipmentLabelRequest\r\n required:\r\n - carrierCode\r\n - serviceCode\r\n - packageCode\r\n - confirmation\r\n - shipDate\r\n - weight\r\n - dimensions\r\n - shipFrom\r\n - shipTo\r\n - insuranceOptions\r\n - internationalOptions\r\n - advancedOptions\r\n - testLabel\r\n type: object\r\n properties:\r\n carrierCode:\r\n type: string\r\n serviceCode:\r\n type: string\r\n packageCode:\r\n type: string\r\n confirmation:\r\n type: string\r\n shipDate:\r\n type: string\r\n weight:\r\n oneOf:\r\n - $ref: '#/components/schemas/Weight6'\r\n - {}\r\n dimensions:\r\n oneOf:\r\n - $ref: '#/components/schemas/Dimensions'\r\n - {}\r\n shipFrom:\r\n oneOf:\r\n - $ref: '#/components/schemas/ShipFrom'\r\n - {}\r\n shipTo:\r\n oneOf:\r\n - $ref: '#/components/schemas/ShipTo3'\r\n - {}\r\n insuranceOptions:\r\n type:\r\n - string\r\n - 'null'\r\n internationalOptions:\r\n type:\r\n - string\r\n - 'null'\r\n advancedOptions:\r\n type:\r\n - string\r\n - 'null'\r\n testLabel:\r\n type: boolean\r\n examples:\r\n - carrierCode: fedex\r\n serviceCode: fedex_ground\r\n packageCode: package\r\n confirmation: delivery\r\n shipDate: 2021-04-03\r\n weight:\r\n value: 3\r\n units: ounces\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n shipFrom:\r\n name: Jason Hodges\r\n company: ShipStation\r\n street1: 2815 Exposition Blvd\r\n street2: Ste 2353242\r\n street3: null\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n country: US\r\n phone: null\r\n residential: false\r\n shipTo:\r\n name: The President\r\n company: US Govt\r\n street1: 1600 Pennsylvania Ave\r\n street2: Oval Office\r\n street3: null\r\n city: Washington\r\n state: DC\r\n postalCode: '20500'\r\n country: US\r\n phone: null\r\n residential: false\r\n insuranceOptions: null\r\n internationalOptions: null\r\n advancedOptions: null\r\n testLabel: false\r\n Weight6:\r\n title: Weight6\r\n required:\r\n - value\r\n - units\r\n type: object\r\n properties:\r\n value:\r\n type: integer\r\n contentEncoding: int32\r\n units:\r\n type: string\r\n examples:\r\n - value: 3\r\n units: ounces\r\n ShipFrom:\r\n title: ShipFrom\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type: string\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n country:\r\n type: string\r\n phone:\r\n type:\r\n - string\r\n - 'null'\r\n residential:\r\n type: boolean\r\n examples:\r\n - name: Jason Hodges\r\n company: ShipStation\r\n street1: 2815 Exposition Blvd\r\n street2: Ste 2353242\r\n street3: null\r\n city: Austin\r\n state: TX\r\n postalCode: '78703'\r\n country: US\r\n phone: null\r\n residential: false\r\n ShipTo3:\r\n title: ShipTo3\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type: string\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n country:\r\n type: string\r\n phone:\r\n type:\r\n - string\r\n - 'null'\r\n residential:\r\n type: boolean\r\n examples:\r\n - name: The President\r\n company: US Govt\r\n street1: 1600 Pennsylvania Ave\r\n street2: Oval Office\r\n street3: null\r\n city: Washington\r\n state: DC\r\n postalCode: '20500'\r\n country: US\r\n phone: null\r\n residential: false\r\n GetRatesRequest:\r\n title: GetRatesRequest\r\n required:\r\n - carrierCode\r\n - serviceCode\r\n - packageCode\r\n - fromPostalCode\r\n - toState\r\n - toCountry\r\n - toPostalCode\r\n - toCity\r\n - weight\r\n - dimensions\r\n - confirmation\r\n - residential\r\n type: object\r\n properties:\r\n carrierCode:\r\n type: string\r\n serviceCode:\r\n type:\r\n - string\r\n - 'null'\r\n packageCode:\r\n type:\r\n - string\r\n - 'null'\r\n fromPostalCode:\r\n type: string\r\n toState:\r\n type: string\r\n toCountry:\r\n type: string\r\n toPostalCode:\r\n type: string\r\n toCity:\r\n type: string\r\n weight:\r\n oneOf:\r\n - $ref: '#/components/schemas/Weight6'\r\n - {}\r\n dimensions:\r\n oneOf:\r\n - $ref: '#/components/schemas/Dimensions'\r\n - {}\r\n confirmation:\r\n type: string\r\n residential:\r\n type: boolean\r\n examples:\r\n - carrierCode: fedex\r\n serviceCode: null\r\n packageCode: null\r\n fromPostalCode: '78703'\r\n toState: DC\r\n toCountry: US\r\n toPostalCode: '20500'\r\n toCity: Washington\r\n weight:\r\n value: 3\r\n units: ounces\r\n dimensions:\r\n units: inches\r\n length: 7\r\n width: 5\r\n height: 6\r\n confirmation: delivery\r\n residential: false\r\n GetRate:\r\n title: GetRate\r\n required:\r\n - serviceName\r\n - serviceCode\r\n - shipmentCost\r\n - otherCost\r\n type: object\r\n properties:\r\n serviceName:\r\n type: string\r\n serviceCode:\r\n type: string\r\n shipmentCost:\r\n type: number\r\n otherCost:\r\n type: number\r\n examples:\r\n - serviceName: USPS First Class Mail - Letter\r\n serviceCode: usps_first_class_mail\r\n shipmentCost: 0.8\r\n otherCost: 0\r\n VoidShipmentLabelRequest:\r\n title: VoidShipmentLabelRequest\r\n required:\r\n - shipmentId\r\n type: object\r\n properties:\r\n shipmentId:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - shipmentId: 12345\r\n ListStore:\r\n title: ListStore\r\n required:\r\n - storeId\r\n - storeName\r\n - marketplaceId\r\n - marketplaceName\r\n - accountName\r\n - email\r\n - integrationUrl\r\n - active\r\n - companyName\r\n - phone\r\n - publicEmail\r\n - website\r\n - refreshDate\r\n - lastRefreshAttempt\r\n - createDate\r\n - modifyDate\r\n - autoRefresh\r\n - statusMappings\r\n type: object\r\n properties:\r\n storeId:\r\n type: integer\r\n contentEncoding: int32\r\n storeName:\r\n type: string\r\n marketplaceId:\r\n type: integer\r\n contentEncoding: int32\r\n marketplaceName:\r\n type: string\r\n accountName:\r\n type:\r\n - string\r\n - 'null'\r\n email:\r\n type:\r\n - string\r\n - 'null'\r\n integrationUrl:\r\n type:\r\n - string\r\n - 'null'\r\n active:\r\n type: boolean\r\n companyName:\r\n type:\r\n - string\r\n - 'null'\r\n phone:\r\n type:\r\n - string\r\n - 'null'\r\n publicEmail:\r\n type:\r\n - string\r\n - 'null'\r\n website:\r\n type:\r\n - string\r\n - 'null'\r\n refreshDate:\r\n type:\r\n - string\r\n - 'null'\r\n lastRefreshAttempt:\r\n type:\r\n - string\r\n - 'null'\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n autoRefresh:\r\n type: boolean\r\n statusMappings:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - storeId: 179188\r\n storeName: Manual Orders\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: ''\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T05:23:13.067\r\n modifyDate: 2021-01-23T05:23:13.067\r\n autoRefresh: false\r\n statusMappings: null\r\n GetStore:\r\n title: GetStore\r\n required:\r\n - storeId\r\n - storeName\r\n - marketplaceId\r\n - marketplaceName\r\n - accountName\r\n - email\r\n - integrationUrl\r\n - active\r\n - companyName\r\n - phone\r\n - publicEmail\r\n - website\r\n - refreshDate\r\n - lastRefreshAttempt\r\n - createDate\r\n - modifyDate\r\n - autoRefresh\r\n - statusMappings\r\n type: object\r\n properties:\r\n storeId:\r\n type: integer\r\n contentEncoding: int32\r\n storeName:\r\n type: string\r\n marketplaceId:\r\n type: integer\r\n contentEncoding: int32\r\n marketplaceName:\r\n type: string\r\n accountName:\r\n type:\r\n - string\r\n - 'null'\r\n email:\r\n type:\r\n - string\r\n - 'null'\r\n integrationUrl:\r\n type:\r\n - string\r\n - 'null'\r\n active:\r\n type: boolean\r\n companyName:\r\n type: string\r\n phone:\r\n type:\r\n - string\r\n - 'null'\r\n publicEmail:\r\n type:\r\n - string\r\n - 'null'\r\n website:\r\n type:\r\n - string\r\n - 'null'\r\n refreshDate:\r\n type:\r\n - string\r\n - 'null'\r\n lastRefreshAttempt:\r\n type:\r\n - string\r\n - 'null'\r\n createDate:\r\n type: string\r\n modifyDate:\r\n type: string\r\n autoRefresh:\r\n type: boolean\r\n statusMappings:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - storeId: 179188\r\n storeName: Manual Orders\r\n marketplaceId: 0\r\n marketplaceName: ShipStation\r\n accountName: null\r\n email: null\r\n integrationUrl: null\r\n active: true\r\n companyName: ''\r\n phone: null\r\n publicEmail: null\r\n website: null\r\n refreshDate: null\r\n lastRefreshAttempt: null\r\n createDate: 2021-01-23T05:23:13.067\r\n modifyDate: 2021-01-23T05:23:13.067\r\n autoRefresh: false\r\n statusMappings: null\r\n DeactivateStoreRequest:\r\n title: DeactivateStoreRequest\r\n required:\r\n - storeId\r\n type: object\r\n properties:\r\n storeId:\r\n type: string\r\n examples:\r\n - storeId: '{{storeId}}'\r\n DeactivateStore:\r\n title: DeactivateStore\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested store has been deactivated.\r\n ReactivateStoreRequest:\r\n title: ReactivateStoreRequest\r\n required:\r\n - storeId\r\n type: object\r\n properties:\r\n storeId:\r\n type: string\r\n examples:\r\n - storeId: '{{storeId}}'\r\n ReactivateStore:\r\n title: ReactivateStore\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested store has been reactivated.\r\n ListMarketplace:\r\n title: ListMarketplace\r\n required:\r\n - name\r\n - marketplaceId\r\n - canRefresh\r\n - supportsCustomMappings\r\n - supportsCustomStatuses\r\n - canConfirmShipments\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n marketplaceId:\r\n type: integer\r\n contentEncoding: int32\r\n canRefresh:\r\n type: boolean\r\n supportsCustomMappings:\r\n type: boolean\r\n supportsCustomStatuses:\r\n type: boolean\r\n canConfirmShipments:\r\n type: boolean\r\n examples:\r\n - name: 3dcart\r\n marketplaceId: 23\r\n canRefresh: true\r\n supportsCustomMappings: true\r\n supportsCustomStatuses: false\r\n canConfirmShipments: true\r\n ListUser:\r\n title: ListUser\r\n required:\r\n - userId\r\n - userName\r\n - name\r\n type: object\r\n properties:\r\n userId:\r\n type: string\r\n userName:\r\n type: string\r\n name:\r\n type: string\r\n examples:\r\n - userId: d52e3087-15dd-412c-a3b5-d66b8ed875c7\r\n userName: admin@gmail.com\r\n name: Divyang Desai\r\n CreateWarehouseRequest:\r\n title: CreateWarehouseRequest\r\n required:\r\n - warehouseName\r\n - originAddress\r\n - returnAddress\r\n - isDefault\r\n type: object\r\n properties:\r\n warehouseName:\r\n type: string\r\n originAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/OriginAddress'\r\n - {}\r\n returnAddress:\r\n type:\r\n - string\r\n - 'null'\r\n isDefault:\r\n type: boolean\r\n examples:\r\n - warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n returnAddress: null\r\n isDefault: false\r\n OriginAddress:\r\n title: OriginAddress\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type:\r\n - string\r\n - 'null'\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n country:\r\n type: string\r\n phone:\r\n type: string\r\n residential:\r\n type: boolean\r\n examples:\r\n - name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n CreateWarehouse:\r\n title: CreateWarehouse\r\n required:\r\n - warehouseId\r\n - warehouseName\r\n - originAddress\r\n - returnAddress\r\n - createDate\r\n - isDefault\r\n - sellerIntegrationId\r\n - extInventoryIdentity\r\n - registerFedexMeter\r\n type: object\r\n properties:\r\n warehouseId:\r\n type: integer\r\n contentEncoding: int32\r\n warehouseName:\r\n type: string\r\n originAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/OriginAddress1'\r\n - {}\r\n returnAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/ReturnAddress'\r\n - {}\r\n createDate:\r\n type: string\r\n isDefault:\r\n type: boolean\r\n sellerIntegrationId:\r\n type:\r\n - string\r\n - 'null'\r\n extInventoryIdentity:\r\n type:\r\n - string\r\n - 'null'\r\n registerFedexMeter:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n OriginAddress1:\r\n title: OriginAddress1\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n - addressVerified\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type:\r\n - string\r\n - 'null'\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n country:\r\n type: string\r\n phone:\r\n type: string\r\n residential:\r\n type: boolean\r\n addressVerified:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n ReturnAddress:\r\n title: ReturnAddress\r\n required:\r\n - name\r\n - company\r\n - street1\r\n - street2\r\n - street3\r\n - city\r\n - state\r\n - postalCode\r\n - country\r\n - phone\r\n - residential\r\n - addressVerified\r\n type: object\r\n properties:\r\n name:\r\n type: string\r\n company:\r\n type: string\r\n street1:\r\n type: string\r\n street2:\r\n type:\r\n - string\r\n - 'null'\r\n street3:\r\n type:\r\n - string\r\n - 'null'\r\n city:\r\n type: string\r\n state:\r\n type: string\r\n postalCode:\r\n type: string\r\n country:\r\n type: string\r\n phone:\r\n type: string\r\n residential:\r\n type:\r\n - string\r\n - 'null'\r\n addressVerified:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n ListWarehouse:\r\n title: ListWarehouse\r\n required:\r\n - warehouseId\r\n - warehouseName\r\n - originAddress\r\n - returnAddress\r\n - createDate\r\n - isDefault\r\n - sellerIntegrationId\r\n - extInventoryIdentity\r\n - registerFedexMeter\r\n type: object\r\n properties:\r\n warehouseId:\r\n type: integer\r\n contentEncoding: int32\r\n warehouseName:\r\n type: string\r\n originAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/OriginAddress1'\r\n - {}\r\n returnAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/ReturnAddress'\r\n - {}\r\n createDate:\r\n type: string\r\n isDefault:\r\n type: boolean\r\n sellerIntegrationId:\r\n type:\r\n - string\r\n - 'null'\r\n extInventoryIdentity:\r\n type:\r\n - string\r\n - 'null'\r\n registerFedexMeter:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n GetWarehouse:\r\n title: GetWarehouse\r\n required:\r\n - warehouseId\r\n - warehouseName\r\n - originAddress\r\n - returnAddress\r\n - createDate\r\n - isDefault\r\n - sellerIntegrationId\r\n - extInventoryIdentity\r\n - registerFedexMeter\r\n type: object\r\n properties:\r\n warehouseId:\r\n type: integer\r\n contentEncoding: int32\r\n warehouseName:\r\n type: string\r\n originAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/OriginAddress1'\r\n - {}\r\n returnAddress:\r\n oneOf:\r\n - $ref: '#/components/schemas/ReturnAddress'\r\n - {}\r\n createDate:\r\n type: string\r\n isDefault:\r\n type: boolean\r\n sellerIntegrationId:\r\n type:\r\n - string\r\n - 'null'\r\n extInventoryIdentity:\r\n type:\r\n - string\r\n - 'null'\r\n registerFedexMeter:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - warehouseId: 511543\r\n warehouseName: New Ship From Location\r\n originAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: true\r\n addressVerified: null\r\n returnAddress:\r\n name: NM Warehouse\r\n company: White Sands Co.\r\n street1: 4704 Arabela Dr.\r\n street2: null\r\n street3: null\r\n city: Las Cruces\r\n state: NM\r\n postalCode: '80012'\r\n country: US\r\n phone: 512-111-2222\r\n residential: null\r\n addressVerified: null\r\n createDate: 2021-01-23T10:14:36.6600000\r\n isDefault: true\r\n sellerIntegrationId: null\r\n extInventoryIdentity: null\r\n registerFedexMeter: null\r\n UpdateWarehouse:\r\n title: UpdateWarehouse\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested warehouse has been updated.\r\n Deleteawarehouse:\r\n title: Deleteawarehouse\r\n required:\r\n - success\r\n - message\r\n type: object\r\n properties:\r\n success:\r\n type: boolean\r\n message:\r\n type: string\r\n examples:\r\n - success: true\r\n message: The requested warehouse has been deleted.\r\n ListWebhooks:\r\n title: ListWebhooks\r\n required:\r\n - webhooks\r\n type: object\r\n properties:\r\n webhooks:\r\n type: array\r\n items:\r\n $ref: '#/components/schemas/Webhook'\r\n examples:\r\n - webhooks:\r\n - IsLabelAPIHook: false\r\n WebHookID: 3189\r\n SellerID: 2335513\r\n StoreID: null\r\n HookType: ORDER_NOTIFY\r\n MessageFormat: Json\r\n Url: http://someexamplewebhookurl.com/neworder\r\n Name: My Webhook\r\n BulkCopyBatchID: null\r\n BulkCopyRecordID: null\r\n Active: true\r\n WebhookLogs: []\r\n Seller: null\r\n Store: null\r\n Webhook:\r\n title: Webhook\r\n required:\r\n - IsLabelAPIHook\r\n - WebHookID\r\n - SellerID\r\n - StoreID\r\n - HookType\r\n - MessageFormat\r\n - Url\r\n - Name\r\n - BulkCopyBatchID\r\n - BulkCopyRecordID\r\n - Active\r\n - WebhookLogs\r\n - Seller\r\n - Store\r\n type: object\r\n properties:\r\n IsLabelAPIHook:\r\n type: boolean\r\n WebHookID:\r\n type: integer\r\n contentEncoding: int32\r\n SellerID:\r\n type: integer\r\n contentEncoding: int32\r\n StoreID:\r\n type:\r\n - string\r\n - 'null'\r\n HookType:\r\n type: string\r\n MessageFormat:\r\n type: string\r\n Url:\r\n type: string\r\n Name:\r\n type: string\r\n BulkCopyBatchID:\r\n type:\r\n - string\r\n - 'null'\r\n BulkCopyRecordID:\r\n type:\r\n - string\r\n - 'null'\r\n Active:\r\n type: boolean\r\n WebhookLogs:\r\n type: array\r\n items:\r\n type: string\r\n Seller:\r\n type:\r\n - string\r\n - 'null'\r\n Store:\r\n type:\r\n - string\r\n - 'null'\r\n examples:\r\n - IsLabelAPIHook: false\r\n WebHookID: 3189\r\n SellerID: 2335513\r\n StoreID: null\r\n HookType: ORDER_NOTIFY\r\n MessageFormat: Json\r\n Url: http://someexamplewebhookurl.com/neworder\r\n Name: My Webhook\r\n BulkCopyBatchID: null\r\n BulkCopyRecordID: null\r\n Active: true\r\n WebhookLogs: []\r\n Seller: null\r\n Store: null\r\n SubscribetoWebhookRequest:\r\n title: SubscribetoWebhookRequest\r\n required:\r\n - target_url\r\n - event\r\n - store_id\r\n - friendly_name\r\n type: object\r\n properties:\r\n target_url:\r\n type: string\r\n event:\r\n type: string\r\n store_id:\r\n type:\r\n - string\r\n - 'null'\r\n friendly_name:\r\n type: string\r\n examples:\r\n - target_url: http://someexamplewebhookurl.com/neworder\r\n event: ORDER_NOTIFY\r\n store_id: null\r\n friendly_name: My Webhook\r\n SubscribetoWebhook:\r\n title: SubscribetoWebhook\r\n required:\r\n - id\r\n type: object\r\n properties:\r\n id:\r\n type: integer\r\n contentEncoding: int32\r\n examples:\r\n - id: 12345\r\n securitySchemes:\r\n basic:\r\n type: http\r\n scheme: basic\r\nsecurity:\r\n- basic: []\r\ntags:\r\n- name: Carriers\r\n- name: Customers\r\n- name: Fulfillments\r\n- name: Orders\r\n- name: Products\r\n- name: Shipment\r\n- name: Stores\r\n- name: Users\r\n- name: Warehouses\r\n- name: Webhooks\r\n",
"url": "https://gist.githubusercontent.com/stchr/5f1a3db6f264a00b490650872a290bf3/raw/7f90cc3f4dc9a356f6ecf5eb0f307ca06ac5f9a2/shipstation-OpenApi3Json.json",
"output": null,
"newLineBehavior": "Auto"
}
},
"codeGenerators": {
"openApiToCSharpClient": {
"clientBaseClass": null,
"configurationClass": null,
"generateClientClasses": true,
"suppressClientClassesOutput": false,
"generateClientInterfaces": true,
"suppressClientInterfacesOutput": false,
"clientBaseInterface": null,
"injectHttpClient": true,
"disposeHttpClient": true,
"protectedMethods": [],
"generateExceptionClasses": true,
"exceptionClass": "ShipStationException",
"wrapDtoExceptions": true,
"useHttpClientCreationMethod": false,
"httpClientType": "System.Net.Http.HttpClient",
"useHttpRequestMessageCreationMethod": false,
"useBaseUrl": false,
"generateBaseUrlProperty": false,
"generateSyncMethods": false,
"generatePrepareRequestAndProcessResponseAsAsyncMethods": false,
"exposeJsonSerializerSettings": true,
"clientClassAccessModifier": "public",
"typeAccessModifier": "public",
"propertySetterAccessModifier": "",
"generateNativeRecords": false,
"generateContractsOutput": false,
"contractsNamespace": null,
"contractsOutputFilePath": null,
"parameterDateTimeFormat": "s",
"parameterDateFormat": "yyyy-MM-dd",
"generateUpdateJsonSerializerSettingsMethod": true,
"useRequestAndResponseSerializationSettings": false,
"serializeTypeInformation": false,
"queryNullValue": "",
"className": "ShipStationClient",
"operationGenerationMode": "MultipleClientsFromOperationId",
"additionalNamespaceUsages": [],
"additionalContractNamespaceUsages": [],
"generateOptionalParameters": false,
"generateJsonMethods": false,
"enforceFlagEnums": false,
"parameterArrayType": "System.Collections.Generic.IEnumerable",
"parameterDictionaryType": "System.Collections.Generic.IDictionary",
"responseArrayType": "System.Collections.Generic.ICollection",
"responseDictionaryType": "System.Collections.Generic.IDictionary",
"wrapResponses": false,
"wrapResponseMethods": [],
"generateResponseClasses": true,
"responseClass": "SwaggerResponse",
"namespace": "ShipStation.NetSdk",
"requiredPropertiesMustBeDefined": true,
"dateType": "System.DateTimeOffset",
"jsonConverters": null,
"anyType": "object",
"dateTimeType": "System.DateTimeOffset",
"timeType": "System.TimeSpan",
"timeSpanType": "System.TimeSpan",
"arrayType": "System.Collections.Generic.ICollection",
"arrayInstanceType": "System.Collections.ObjectModel.Collection",
"dictionaryType": "System.Collections.Generic.IDictionary",
"dictionaryInstanceType": "System.Collections.Generic.Dictionary",
"arrayBaseType": "System.Collections.ObjectModel.Collection",
"dictionaryBaseType": "System.Collections.Generic.Dictionary",
"classStyle": "Poco",
"jsonLibrary": "SystemTextJson",
"generateDefaultValues": true,
"generateDataAnnotations": true,
"excludedTypeNames": [],
"excludedParameterNames": [],
"handleReferences": false,
"generateImmutableArrayProperties": false,
"generateImmutableDictionaryProperties": false,
"jsonSerializerSettingsTransformationMethod": null,
"inlineNamedArrays": false,
"inlineNamedDictionaries": false,
"inlineNamedTuples": true,
"inlineNamedAny": true,
"generateDtoTypes": true,
"generateOptionalPropertiesAsNullable": true,
"generateNullableReferenceTypes": true,
"templateDirectory": null,
"serviceHost": null,
"serviceSchemes": null,
"output": "ShipStation.NetSdk/ShipStation.NetSdk.Core/ShipStationClient.cs",
"newLineBehavior": "Auto"
}
}
}