Requests
The request services below provide the ability to manage requests expected to be completed by Quipt merchants. The provided services can be used to download, acknowledge, and close requests. Click here for a few use cases using the request services.
Get Requests
This services allows a partner to retrieve a paged list of request records a partner has currently listed within Quipt.
URLhttps://api.getquipt.com/v2/requests/fulfillment/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &status | A comma separated list of request statuses, (2 = Pending, 4 = Open, 8 = Closed, and, 16 = Canceled). | Int | No |
| &channelId | Either the Quipt identifier for the channel, or the code set as the partner reference within the partner's settings. | String | No |
| &include | A comma separated list of properties to include with result. Valid options are Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/requests/fulfillment/100/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
{ "Paging": { "PageNumber": 1, "Total": 605, "HasMoreRecords": true }, "Result": [ { "GroupReferenceNumber": "GroupRefNumber", "ActionReferenceNumber": "RequestRefNumber", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel": { "Code": "RetailerCode", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "RetailerName" }, "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" }, "FOB": 10, "Status": 4, "CreatedAt": "2015-08-21T23:43:41.407", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "FillLine": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status": 256, "PickStatus": 0, "VendorSKU": "SampleSKU", "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Cost": { "Value": 0.0000, "Units": 0 }, "Invoice": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber": "InvNumber", "InvoicedAt": "2015-08-11T00:00:00" }, "Line": { "Item": { "Title": "HP EliteBook 8460P Intel Core i5-2520M X2 2.5GHz 4GB 320GB DVD+/-RW 14'' Win7Pro (Platinum)", "Condition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Weight": { "Units": 10, "Value": 8.0000 }, "Dimensions": { "Length": 19.0, "Width": 17.0, "Height": 6.0, "Units": 0 }, "MapId": "SampleMapId", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU": "SampleSKU", "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" } }, "Canceled": { "Units": 0, "Value": 0.0000 }, "BackOrdered": { "ExpectedAt": null, "Units": 0, "Value": 0.0000 }, "Shipped": { "Units": 0, "Value": 1.0000 }, "LineNumber": 0, "Ordered": { "Units": 0, "Value": 1.0000 }, "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "RequestedShipDate": null, "Status": 8, "StatusAt": "2015-08-11T03:35:14.293", "SubStatus": 0, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial": null }, "Tracking": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "TrackingURL": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=TrackingNumberValue", "CreatedAt": "2015-08-10T11:28:24.053", "CurrentStatus": 8192, "LastUpdatedAt": "2015-08-12T21:40:57.11", "EstimatedDelivery": null, "TrackingNumber": "TrackingNumberValue", "CarrierMethod": { "Id": "a9830d9a-c582-49e0-ae90-79d75ad0c7ce", "Carrier": { "Id": "dc3e82a2-a51a-4314-bfa1-a1ad6eca420d", "Name": "UPS", "Code": "UPS" }, "Name": "Ground", "Code": "UPSGD" } }, "OrderLine": { "Fulfillments": [ ], "Acknowledgements": null, "SubstitutionFor": null, "Item": { "Title": "HP EliteBook 8460P Intel Core i5-2520M X2 2.5GHz 4GB 320GB DVD+/-RW 14'' Win7Pro (Platinum)", "Condition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Weight": { "Units": 10, "Value": 8.0000 }, "Dimensions": { "Length": 19.0, "Width": 17.0, "Height": 6.0, "Units": 0 }, "MapId": "SampleMapId", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU": "SampleSKU", "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" } }, "Canceled": { "Units": 0, "Value": 0.0000 }, "BackOrdered": { "ExpectedAt": null, "Units": 0, "Value": 0.0000 }, "Shipped": { "Units": 0, "Value": 1.0000 }, "LineNumber": 0, "Ordered": { "Units": 0, "Value": 1.0000 }, "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "RequestedShipDate": null, "Status": 8, "StatusAt": "2015-08-11T03:35:14.293", "SubStatus": 0, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Status": 4, "StatusAt": "2015-08-21T23:53:10.187", "InterceptDetails": null, "LostShipmentDetails": null, "MissingAccessoryDetails": null, "ClaimDetails": null, "CreditDetails": null, "ReturnDetails": { "Tracking": null, "ReturnTo": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Address": { "City": "CityName", "PostalCode": "00000", "State": "CA", "StreetLine1": "1234 Sample Street Name", "StreetLine2": null, "StreetLine3": null, "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } }, "DisplayName": null }, "IsYourReturnToWarehouse": false, "Status": 0, "StatusAt": "2015-08-21T23:53:10.187", "Notes": null, "ReferenceNumber": "RequestRefNumber", "CreditDetails": null, "Replacement": null, "PrepaidLabel": null, "OriginalCondition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Label": null, "UnidentifiedItemId": null, "OriginalSource": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" }, "ReturnCarrierMethod": null, "ReturnTrackingNumber": null, "ReadyForResale": null }, "SLA": null, "OriginalChannelInvoice": null, "ActionReferenceNumber": null, "UserDefined4": null, "UserDefined5": null, "UserDefined6": "EA", "Serials": null, "SKU": "SP604UPABA", "MapId": "HQR-102938050", "UserDefined1": null, "UserDefined2": null, "UserDefined3": null } ], "Group": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "RetailerName" }, "Type": 1, "PurchaseOrderNumber": "PurchaseOrderNumber", "ReferenceNumber": "PurchaseOrderRef1", "EndCustomerReferenceNumber": "PurchaseOrderRef2", "ShipTo": { "IsResidential": true, "Company": null, "Attention": "End Customer Name", "PhoneNumber": { "CountryISO": "US", "Number": "0000000000" }, "EmailAddress": "emailaddress@getquipt.com", "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "Address Line 1", "StreetLine2": "", "StreetLine3": "", "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } }, "Gift": { "Wrap": false, "Message": null }, "GenerateSSCCCode": false, "LabelReference1": null, "LabelReference2": null }, "Tax": null, "Freight": null, "Discount": null, "Miscellaneous": null, "SubTotal": null, "UserDefined4": null, "UserDefined5": null, "UserDefined6": null, "Return": { "Type": 5, "Resolution": 5, "GenerateReturnLabel": false, "GenerateReturnLabelEmailTo": null, "GenerateReturnCarrierMethod": null, "AdvancedReplacement": false, "AdvancedReplacementCarrierMethod": null, "ReturnFrom": { "IsResidential": true, "Company": null, "Attention": "End Customer Name", "PhoneNumber": { "CountryISO": "US", "Number": "0000000000" }, "EmailAddress": "emailaddress@getquipt.com", "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "1234 Sample Street Name", "StreetLine2": "", "StreetLine3": "", "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } } }, "Credit": null, "MissingAccessory": null, "Notes": null, "Type": 1000, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "ReferenceNumber": "RequestRefNum" } ], "TransactionId": null, "TransactionTime": "2017-01-05T01:03:53.0544075Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of purchase order results. | RequestResult[] |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Get Requests By Channel
This services allows a partner to retrieve a paged list of inventory records a partner has currently listed within Quipt.
URLhttps://api.getquipt.com/v2/requests/fulfillment/{channelId}/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {channelId} | String | No | |
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &requestStatus | A comma separated list of request statuses, (2 = Pending, 4 = Open, 8 = Closed, and, 16 = Canceled). | Int | No |
| &include | A comma separated list of properties to include with result. Valid options are Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/requests/fulfillment//100/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
{ "Paging": { "PageNumber": 1, "Total": 605, "HasMoreRecords": true }, "Result": [ { "GroupReferenceNumber": "GroupRefNumber", "ActionReferenceNumber": "RequestRefNumber", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel": { "Code": "RetailerCode", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "RetailerName" }, "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" }, "FOB": 10, "Status": 4, "CreatedAt": "2015-08-21T23:43:41.407", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "FillLine": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status": 256, "PickStatus": 0, "VendorSKU": "SampleSKU", "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Cost": { "Value": 0.0000, "Units": 0 }, "Invoice": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber": "InvNumber", "InvoicedAt": "2015-08-11T00:00:00" }, "Line": { "Item": { "Title": "HP EliteBook 8460P Intel Core i5-2520M X2 2.5GHz 4GB 320GB DVD+/-RW 14'' Win7Pro (Platinum)", "Condition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Weight": { "Units": 10, "Value": 8.0000 }, "Dimensions": { "Length": 19.0, "Width": 17.0, "Height": 6.0, "Units": 0 }, "MapId": "SampleMapId", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU": "SampleSKU", "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" } }, "Canceled": { "Units": 0, "Value": 0.0000 }, "BackOrdered": { "ExpectedAt": null, "Units": 0, "Value": 0.0000 }, "Shipped": { "Units": 0, "Value": 1.0000 }, "LineNumber": 0, "Ordered": { "Units": 0, "Value": 1.0000 }, "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "RequestedShipDate": null, "Status": 8, "StatusAt": "2015-08-11T03:35:14.293", "SubStatus": 0, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial": null }, "Tracking": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "TrackingURL": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=TrackingNumberValue", "CreatedAt": "2015-08-10T11:28:24.053", "CurrentStatus": 8192, "LastUpdatedAt": "2015-08-12T21:40:57.11", "EstimatedDelivery": null, "TrackingNumber": "TrackingNumberValue", "CarrierMethod": { "Id": "a9830d9a-c582-49e0-ae90-79d75ad0c7ce", "Carrier": { "Id": "dc3e82a2-a51a-4314-bfa1-a1ad6eca420d", "Name": "UPS", "Code": "UPS" }, "Name": "Ground", "Code": "UPSGD" } }, "OrderLine": { "Fulfillments": [ ], "Acknowledgements": null, "SubstitutionFor": null, "Item": { "Title": "HP EliteBook 8460P Intel Core i5-2520M X2 2.5GHz 4GB 320GB DVD+/-RW 14'' Win7Pro (Platinum)", "Condition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Weight": { "Units": 10, "Value": 8.0000 }, "Dimensions": { "Length": 19.0, "Width": 17.0, "Height": 6.0, "Units": 0 }, "MapId": "SampleMapId", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU": "SampleSKU", "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" } }, "Canceled": { "Units": 0, "Value": 0.0000 }, "BackOrdered": { "ExpectedAt": null, "Units": 0, "Value": 0.0000 }, "Shipped": { "Units": 0, "Value": 1.0000 }, "LineNumber": 0, "Ordered": { "Units": 0, "Value": 1.0000 }, "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "RequestedShipDate": null, "Status": 8, "StatusAt": "2015-08-11T03:35:14.293", "SubStatus": 0, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Status": 4, "StatusAt": "2015-08-21T23:53:10.187", "InterceptDetails": null, "LostShipmentDetails": null, "MissingAccessoryDetails": null, "ClaimDetails": null, "CreditDetails": null, "ReturnDetails": { "Tracking": null, "ReturnTo": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Address": { "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "1234 Sample Street Name", "StreetLine2": null, "StreetLine3": null, "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } }, "DisplayName": null }, "IsYourReturnToWarehouse": false, "Status": 0, "StatusAt": "2015-08-21T23:53:10.187", "Notes": null, "ReferenceNumber": "RequestRefNumber", "CreditDetails": null, "Replacement": null, "PrepaidLabel": null, "OriginalCondition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Label": null, "UnidentifiedItemId": null, "OriginalSource": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" }, "ReturnCarrierMethod": null, "ReturnTrackingNumber": null, "ReadyForResale": null }, "SLA": null, "OriginalChannelInvoice": null, "ActionReferenceNumber": null, "UserDefined4": null, "UserDefined5": null, "UserDefined6": "EA", "Serials": null, "SKU": "SP604UPABA", "MapId": "HQR-102938050", "UserDefined1": null, "UserDefined2": null, "UserDefined3": null } ], "Group": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "RetailerName" }, "Type": 1, "PurchaseOrderNumber": "PurchaseOrderNumber", "ReferenceNumber": "PurchaseOrderRef1", "EndCustomerReferenceNumber": "PurchaseOrderRef2", "ShipTo": { "IsResidential": true, "Company": null, "Attention": "End Customer Name", "PhoneNumber": { "CountryISO": "US", "Number": "0000000000" }, "EmailAddress": "emailaddress@getquipt.com", "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "1234 Sample Street Name", "StreetLine2": "", "StreetLine3": "", "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } }, "Gift": { "Wrap": false, "Message": null }, "GenerateSSCCCode": false, "LabelReference1": null, "LabelReference2": null }, "Tax": null, "Freight": null, "Discount": null, "Miscellaneous": null, "SubTotal": null, "UserDefined4": null, "UserDefined5": null, "UserDefined6": null, "Return": { "Type": 5, "Resolution": 5, "GenerateReturnLabel": false, "GenerateReturnLabelEmailTo": null, "GenerateReturnCarrierMethod": null, "AdvancedReplacement": false, "AdvancedReplacementCarrierMethod": null, "ReturnFrom": { "IsResidential": true, "Company": null, "Attention": "End Customer Name", "PhoneNumber": { "CountryISO": "US", "Number": "0000000000" }, "EmailAddress": "emailaddress@getquipt.com", "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "1234 Sample Street Name", "StreetLine2": "", "StreetLine3": "", "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } } }, "Credit": null, "MissingAccessory": null, "Notes": null, "Type": 1000, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "ReferenceNumber": "RequestRefNum" } ], "TransactionId": null, "TransactionTime": "2017-01-05T01:03:53.0544075Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of purchase order results. | RequestResult[] |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Get Request By Id
This services allows a partner to retrieve a paged list of inventory records a partner has currently listed within Quipt.
URLhttps://api.getquipt.com/v2/requests/fulfillment/id/{id}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {id} | The Quipt identifier. | Guid | Yes |
| &include | A comma separated list of properties to include with result. Valid options are Group, Lines.FillLine, Lines.Tracking, Lines.OrderLine, Lines.OrderLine.Fulfillments, and Lines.OrderLine.Acknowledgements. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/requests/fulfillment/id/00000000-0000-0000-0000-000000000000 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
{ "GroupReferenceNumber": "GroupRefNumber", "ActionReferenceNumber": "RequestRefNumber", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "RetailerName" }, "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" }, "FOB": 10, "Status": 4, "CreatedAt": "2015-08-21T23:43:41.407", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "FillLine": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status": 256, "PickStatus": 0, "VendorSKU": "SampleSKU", "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Cost": { "Value": 0.0000, "Units": 0 }, "Invoice": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber": "InvNumber", "InvoicedAt": "2015-08-11T00:00:00" }, "Line": { "Item": { "Title": "HP EliteBook 8460P Intel Core i5-2520M X2 2.5GHz 4GB 320GB DVD+/-RW 14'' Win7Pro (Platinum)", "Condition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Weight": { "Units": 10, "Value": 8.0000 }, "Dimensions": { "Length": 19.0, "Width": 17.0, "Height": 6.0, "Units": 0 }, "MapId": "SampleMapId", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU": "SampleSKU", "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" } }, "Canceled": { "Units": 0, "Value": 0.0000 }, "BackOrdered": { "ExpectedAt": null, "Units": 0, "Value": 0.0000 }, "Shipped": { "Units": 0, "Value": 1.0000 }, "LineNumber": 0, "Ordered": { "Units": 0, "Value": 1.0000 }, "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "RequestedShipDate": null, "Status": 8, "StatusAt": "2015-08-11T03:35:14.293", "SubStatus": 0, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial": null }, "Tracking": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "TrackingURL": "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=TrackingNumberValue", "CreatedAt": "2015-08-10T11:28:24.053", "CurrentStatus": 8192, "LastUpdatedAt": "2015-08-12T21:40:57.11", "EstimatedDelivery": null, "TrackingNumber": "TrackingNumberValue", "CarrierMethod": { "Id": "a9830d9a-c582-49e0-ae90-79d75ad0c7ce", "Carrier": { "Id": "dc3e82a2-a51a-4314-bfa1-a1ad6eca420d", "Name": "UPS", "Code": "UPS" }, "Name": "Ground", "Code": "UPSGD" } }, "OrderLine": { "Fulfillments": [ ], "Acknowledgements": null, "SubstitutionFor": null, "Item": { "Title": "HP EliteBook 8460P Intel Core i5-2520M X2 2.5GHz 4GB 320GB DVD+/-RW 14'' Win7Pro (Platinum)", "Condition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Weight": { "Units": 10, "Value": 8.0000 }, "Dimensions": { "Length": 19.0, "Width": 17.0, "Height": 6.0, "Units": 0 }, "MapId": "SampleMapId", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU": "SampleSKU", "Vendor": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" } }, "Canceled": { "Units": 0, "Value": 0.0000 }, "BackOrdered": { "ExpectedAt": null, "Units": 0, "Value": 0.0000 }, "Shipped": { "Units": 0, "Value": 1.0000 }, "LineNumber": 0, "Ordered": { "Units": 0, "Value": 1.0000 }, "Tax": { "Value": 0.0000, "Units": 0 }, "Miscellaneous": { "Value": 0.0000, "Units": 0 }, "Discount": { "Value": 0.0000, "Units": 0 }, "Freight": { "Value": 0.0000, "Units": 0 }, "Price": { "Value": 239.1900, "Units": 0 }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "RequestedShipDate": null, "Status": 8, "StatusAt": "2015-08-11T03:35:14.293", "SubStatus": 0, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Status": 4, "StatusAt": "2015-08-21T23:53:10.187", "InterceptDetails": null, "LostShipmentDetails": null, "MissingAccessoryDetails": null, "ClaimDetails": null, "CreditDetails": null, "ReturnDetails": { "Tracking": null, "ReturnTo": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Address": { "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "1234 Sample Street", "StreetLine2": null, "StreetLine3": null, "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } }, "DisplayName": null }, "IsYourReturnToWarehouse": false, "Status": 0, "StatusAt": "2015-08-21T23:53:10.187", "Notes": null, "ReferenceNumber": "RequestRefNumber", "CreditDetails": null, "Replacement": null, "PrepaidLabel": null, "OriginalCondition": { "Id": "09390378-2b79-4df5-bc21-48d6de8b502b", "Name": "Refurbished", "Code": "REFURB3RD" }, "Label": null, "UnidentifiedItemId": null, "OriginalSource": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "MerchantName" }, "ReturnCarrierMethod": null, "ReturnTrackingNumber": null, "ReadyForResale": null }, "SLA": null, "OriginalChannelInvoice": null, "ActionReferenceNumber": null, "UserDefined4": null, "UserDefined5": null, "UserDefined6": "EA", "Serials": null, "SKU": "SampleSKU", "MapId": "SampleMapId", "UserDefined1": null, "UserDefined2": null, "UserDefined3": null } ], "Group": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": "RetailerName" }, "Type": 1, "PurchaseOrderNumber": "PurchaseOrderNumber", "ReferenceNumber": "PurchaseOrderRef1", "EndCustomerReferenceNumber": "PurchaseOrderRef2", "ShipTo": { "IsResidential": true, "Company": null, "Attention": "End Customer Name", "PhoneNumber": { "CountryISO": "US", "Number": "0000000000" }, "EmailAddress": "emailaddress@getquipt.com", "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "Address Line 1", "StreetLine2": "", "StreetLine3": "", "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } }, "Gift": { "Wrap": false, "Message": null }, "GenerateSSCCCode": false, "LabelReference1": null, "LabelReference2": null }, "Tax": null, "Freight": null, "Discount": null, "Miscellaneous": null, "SubTotal": null, "UserDefined4": null, "UserDefined5": null, "UserDefined6": null, "Return": { "Type": 5, "Resolution": 5, "GenerateReturnLabel": false, "GenerateReturnLabelEmailTo": null, "GenerateReturnCarrierMethod": null, "AdvancedReplacement": false, "AdvancedReplacementCarrierMethod": null, "ReturnFrom": { "IsResidential": true, "Company": null, "Attention": "End Customer Name", "PhoneNumber": { "CountryISO": "US", "Number": "0000000000" }, "EmailAddress": "emailaddress@getquipt.com", "City": "City", "PostalCode": "00000", "State": "CA", "StreetLine1": "Address Line 1", "StreetLine2": "", "StreetLine3": "", "Country": { "ISO": "US", "ISO3": "USA", "Name": "United States" } } }, "Credit": null, "MissingAccessory": null, "Notes": null, "Type": 1000, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "ReferenceNumber": "RequestRefNum" } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The request result. | RequestResult |
Acknowledge
This service provides a mechanism to acknowledge a request. It provides a mechanism to both accept and reject a reqyest.
URLhttps://api.getquipt.com/Requests/Fulfillment/Acknowledge
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Acknowledgements | The collection of request acknowledgements for the request. | Request.Acknowledgement[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/acknowledge Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
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 |
{ "Acknowledgements": [ { "Request": { "Id": null, "ReferenceNumber": "R2800433" }, "Lines": [ { "SKU": "SampleSKU", "Accepted": { "Quantity": { "Units": 131, "Value": 1.0 } }, "Rejected": { "ReasonCode": "OTHER", "ReasonText": "Sample Reason Text", "Quantity": { "Units": 131, "Value": 1.0 } }, "Id": null } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T00:38:41.6701524Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Create
This services allows a partner to create a new request for a closed order.
URLhttps://api.getquipt.com/v2/requests/fulfillment/create
Methodpost
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to create. | Request[] | Yes |
| UnidentifiedItems | The collection of unidentified items to create. | UnidentifiedItem[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
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 |
{ "Requests": [ { "Return": { "Type": 5, "Resolution": 5, "GenerateReturnLabel": false, "GenerateReturnLabelEmailTo": null, "GenerateReturnCarrierMethod": null, "AdvancedReplacement": false, "AdvancedReplacementCarrierMethod": null, "ReturnFrom": null }, "Credit": null, "MissingAccessory": null, "Notes": null, "Type": 1000, "PurchaseOrder": { "Id": null, "Vendor": null, "Channel": null, "PurchaseOrderNumber": "PurchaseOrderNumber" }, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null, "Lines": [ { "Id": null, "FillLine": null, "Serials": null, "Request": null, "ReturnDetails": { "ReturnCarrierMethod": { "Id": null, "Carrier": null, "Name": null, "Code": "UPSGD" }, "ReturnTrackingNumber": "TrackingNumberValue", "ReadyForResale": null, "ReturnTo": null, "UnidentifiedItemId": null }, "MissingAccessoryDetails": null, "SKU": "SKU001", "MapId": null, "UserDefined1": null, "UserDefined2": null, "UserDefined3": null } ], "Id": null, "ReferenceNumber": null } ], "UnidentifiedItems" : [{ "ReferenceNumber" : "ReferenceNumberValue", "PartNumber" : "PartNumberValue", "SerialNumber" : "SerialNumberValue", "Notes" : "NotesText", "Warehouse" : { "Code" : "WarehouseCodeValue" }, "Channel" : { "Code" : "CodeValue" }, "Tracking" : { "CarrierMethod" : { "Code" : "FDXGD" }, "TrackingNumber" : "TrackingNumberValue" } } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T00:50:52.5927785Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Update Return
This services allows a partner to apply an action to a return request.
URLhttps://api.getquipt.com/v2/requests/fulfillment/returnupdate
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to update. | Request.ReturnUpdateRequest[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/returnupdate Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
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 |
{ "Requests": [ { "Action": 15, "Request": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }, "NewReferenceNumber": "Ref001", "Notes": "Notes Text", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Exchange": { "CarrierMethod": { "Id": null, "Carrier": null, "Name": null, "Code": "UPSGD" } }, "Credit": { "HasRestockingFee": false }, "Accept": { "ReplacementItem": { "Id": null, "SKU": "SKU001", "Vendor": { "Code": "VendorCode", "Id": null, "Name": null } } }, "ReturnedTo": { "Warehouse": { "Id": null, "Code": "WH1" }, "ReadyForResale": false }, "CarrierMethod": { "Id": null, "Carrier": null, "Name": null, "Code": "UPSGD" }, "TrackingNumber": "Tracking001" } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T18:40:31.7164163Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Missing Accessory Update
This services allows a partner to apply an action to a missing accessory request.
URLhttps://api.getquipt.com/v2/requests/fulfillment/missingaccessoryupdate
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to update. | Request.MissingAccessoryUpdateRequest[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/missingaccessoryupdate Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
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 |
{ "Requests": [ { "Request": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }, "Action": 40, "NewReferenceNumber": "J9673531", "Notes": "Notes Text", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Credit": { "Amount": { "Value": 5.0, "Units": 0 } }, "Shipped": { "Weight": { "Units": 10, "Value": 2.0 }, "CarrierMethod": { "Id": null, "Carrier": null, "Name": null, "Code": "UPSGD" }, "TrackingNumber": "Tracking001", "ItemsToBeShipped": [ "item1", "item2" ] } } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T19:21:48.1080727Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Lost Shipment Update
This services allows a partner apply an action to a lost shipment request.
URLhttps://api.getquipt.com/v2/requests/fulfillment/lostshipmentupdate
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to update. | Request.LostShipmentUpdateRequest[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/lostshipmentupdate Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
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 |
{ "Requests": [ { "Request": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }, "NewReferenceNumber": "PO091645", "Notes": "Notes Text", "Action": 35, "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "ReturnedTo": { "Warehouse": { "Id": null, "Code": "WH1" }, "ReadyForResale": false, "CreateReturn": false } } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T19:21:48.1080727Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Intercept Update
This services allows a partner apply an action to an intercept request.
URLhttps://api.getquipt.com/v2/requests/fulfillment/interceptupdate
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to update. | Request.InterceptUpdateRequest[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/interceptupdate Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
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 |
{ "Requests": [ { "Request": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }, "NewReferenceNumber": "ref001", "Action": 20, "Notes": "Notes Text", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "ReturnedTo": { "Warehouse": { "Id": null, "Code": "WH1" }, "ReadyForResale": true, "CreateReturn": true } } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T19:21:48.1080727Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Credit Update
This services allows a partner apply an action to a credit request.
URLhttps://api.getquipt.com/v2/requests/fulfillment/creditupdate
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to update. | Request.CreditUpdateRequest[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/creditupdate Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ "Requests": [ { "Request": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }, "Action": 5, "NewReferenceNumber": "ref001", "Notes": "Notes Text", "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Credit": { "Amount": { "Value": 25.0, "Units": 0 } } } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T19:21:48.1080727Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Cancel
This services allows a partner to request a cancellation of a request.
URLhttps://api.getquipt.com/v2/requests/fulfillment/cancel
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of requests to cancel. | Request.CancelRequest[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/requests/fulfillment/cancel Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
{ "Requests": [ { "Request": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }, "Reason": { "Id": null, "Code": "CUSTREQ", "Text": null }, "ForceCancelation": true, "Lines": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ] } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T19:44:58.5647315Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Archive
This service allows a partner to archive a request. The primary purpose of archiving an request is to remove it from the lists that are obtained using ‘Get Requests’ and ‘Get Requests By Channel’. This mechanism is not required, and will be automatically applied after 30 days.
URLhttps://api.getquipt.com/v2/requests/fulfillment/archive
Methodpost
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Requests | The collection of request ids. | RequestLookup[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/requests/fulfillment/archive Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
1 2 3 4 5 6 |
{ "Requests": [{ "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeef", }], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-06T19:44:58.5647315Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Batch Report
This service allows a partner to retrieve the detailed report generated when any of the action services are used. The result of ‘Acknowledge’, ‘Cancel’, ‘Create’, ‘Return Update’, ‘Lost Shipment Update’, ‘Intecept Update’, ‘Missing Accessory Update’, ‘Credit Update’ and ‘Archive’ returns the {id} used to retrieve the report from this service.
URLhttps://api.getquipt.com/v2/orders/fulfillment/report/{id}/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| {id} | The report identifier. | Guid | Yes |
| &includeLines | Flag whether or not to include the line details. | Boolean | No |
Sample Header:
|
1 2 3 |
GET https://api.getquipt.com/Requests/Fulfillment/Report/CAC77599-F9F8-45D1-9DE9-CBACFE6E4903/10/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
{ "Result": [ { "RequestId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status": 64, "Message": "", "Record": 1 } ], "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "ReportTime": "2014-10-14T16:35:47.43", "ReportStatus": 64, "Paging": { "PageNumber": 1, "Total": 1, "HasMoreRecords": false }, "TransactionId": null, "TransactionTime": "2017-01-06T18:22:55.3149187Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The collection of purchase order reports. | RequestReport[] |
| ReportId | The report id. | Guid |
| ReportTime | The time the report was generated. | DateTime |
| ReportStatus | The current status of the report. | Int |
| Paging | Paging information for the records returned. | Paging |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |