Orders
The order services provide the ability to manage orders expected to be fulfilled by Quipt merchants. The provided services may be used to download, acknowledge, ship, invoice, and cancel orders. Click here for a few use cases using the order services.
Get Orders
This service allows a partner to retrieve a paged list of orders placed by a retailer.
URLhttps://api.getquipt.com/v2/orders/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 |
| &orderStatus | A comma separated list of order statuses, (2 = Pending, 4 = Open, 8 = Shipped, and, 16 = Canceled). | Int | No |
| &include | A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/orders/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 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
{ "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : false }, "Result" : [{ "SourcedBy" : [], "SubTotal" : { "Value" : 79.76000000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Total" : { "Value" : 79.76000000, "Units" : 0 }, "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "RemitTo" : { "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "FaxNumber" : null, "Company" : "CompanyName", "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "FreightCollection" : 1, "Status" : 4, "SubStatus" : 0, "Lines" : [{ "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "Packingslips" : null, "ShipByTruckRequests" : [], "Shipments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "Fills" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 2, "PickStatus" : 0, "VendorSKU" : "SampleSKU", "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Cost" : { "Value" : 0.0000, "Units" : 0 }, "Invoice" : null, "Line" : { "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SAMPLE-SKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial" : null } ], "Status" : 0, "ErrorMessage" : null, "EstimatedFreight" : null, "InsurableValue" : { "Value" : 39.8800, "Units" : 0 }, "Tracking" : null, "Invoices" : [], "Packingslip" : null, "Labels" : null, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "ShipAt" : "2015-03-06T00:00:00", "UserDefined1" : null, "UserDefined2" : null, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "CarrierAccountDetails" : null, "SSCC" : null } ], "Invoices" : [], "Cancelations" : [], "Notes" : null, "Comments" : [], "Group" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "Type" : 1, "PurchaseOrderNumber" : "PoNumber", "ReferenceNumber" : "ReferenceNumber", "EndCustomerReferenceNumber" : "EndCustomerReferenceNumber", "ShipTo" : { "IsResidential" : false, "Company" : "", "Attention" : "AttentionName", "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345-1234", "State" : "FL", "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 }, "CreatedAt" : "2015-03-06T23:53:49.183", "Type" : 1, "ReferenceNumber" : null, "BillTo" : { "Company" : "CompanyName", "Attention" : null, "PhoneNumber" : null, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "Suite 123", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "SpecialInstructions" : null, "SignatureOption" : 0, "InsuranceOption" : 0, "FOB" : 10, "CarrierMethod" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Carrier" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Name" : "CarrierName", "Code" : "BESTGD" }, "AccountDetails" : null, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "Payments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "PaymentInfo" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "PaymentCode", "Name" : "PaymentName" }, "Amount" : { "Value" : 79.7600, "Units" : 0 }, "CreditCardInfo" : null } ], "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" } ], "TransactionId" : null, "TransactionTime" : "2015-12-31T18:39:35.1681699Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of purchase order results. | PurchaseOrderResult[] |
| 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 Order By Id
This service allows a partner to retrieve an order by the Quipt identifier.
URLhttps://api.getquipt.com/v2/orders/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 Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/orders/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 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 |
{ "SourcedBy" : [], "SubTotal" : { "Value" : 79.76000000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Total" : { "Value" : 79.76000000, "Units" : 0 }, "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "RemitTo" : { "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "FaxNumber" : null, "Company" : "CompanyName", "City" : "Temecula", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "FreightCollection" : 1, "Status" : 4, "SubStatus" : 0, "Lines" : [{ "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "Packingslips" : null, "ShipByTruckRequests" : [], "Shipments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "Fills" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 2, "PickStatus" : 0, "VendorSKU" : "SampleSKU", "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Cost" : { "Value" : 0.0000, "Units" : 0 }, "Invoice" : null, "Line" : { "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial" : null } ], "Status" : 0, "ErrorMessage" : null, "EstimatedFreight" : null, "InsurableValue" : { "Value" : 39.8800, "Units" : 0 }, "Tracking" : null, "Invoices" : [], "Packingslip" : null, "Labels" : null, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "ShipAt" : "2015-03-06T00:00:00", "UserDefined1" : null, "UserDefined2" : null, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "CarrierAccountDetails" : null, "SSCC" : null } ], "Invoices" : [], "Cancelations" : [], "Notes" : null, "Comments" : [], "Group" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "Type" : 1, "PurchaseOrderNumber" : "PoNumber", "ReferenceNumber" : "ReferenceNumber", "EndCustomerReferenceNumber" : "EndCustomerReferenceNumber", "ShipTo" : { "IsResidential" : false, "Company" : "", "Attention" : "AttentionName", "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345-1234", "State" : "FL", "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 }, "CreatedAt" : "2015-03-06T23:53:49.183", "Type" : 1, "ReferenceNumber" : null, "BillTo" : { "Company" : "CompanyName", "Attention" : null, "PhoneNumber" : null, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "Sample Suite 123", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "SpecialInstructions" : null, "SignatureOption" : 0, "InsuranceOption" : 0, "FOB" : 10, "CarrierMethod" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Carrier" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "AccountDetails" : null, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "Payments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "PaymentInfo" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "PaymentMethodCode", "Name" : "PaymentMethodName" }, "Amount" : { "Value" : 79.7600, "Units" : 0 }, "CreditCardInfo" : null } ], "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The purchase order result. | PurchaseOrderResult |
Get Order By Purchase Order Number
This service allows a partner to retrieve an order by the retailer’s original order number.
URLhttps://api.getquipt.com/v2/orders/fulfillment/po/{retailerId}/{poNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {retailerId} | Either the Quipt identifier for the channel, or the code set as the partner reference within the partner's settings. | Guid | Yes |
| {poNumber} | The original purchase order number. | String | No |
| &include | A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/orders/fulfillment/po/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/MyPoNumber 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 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
{ "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : false }, "Result" : [{ "SourcedBy" : [], "SubTotal" : { "Value" : 79.76000000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Total" : { "Value" : 79.76000000, "Units" : 0 }, "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "RemitTo" : { "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "FaxNumber" : null, "Company" : "CompanyName", "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "FreightCollection" : 1, "Status" : 4, "SubStatus" : 0, "Lines" : [{ "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "Sample Title", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "Packingslips" : null, "ShipByTruckRequests" : [], "Shipments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "Fills" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 2, "PickStatus" : 0, "VendorSKU" : "SampleSKU", "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Cost" : { "Value" : 0.0000, "Units" : 0 }, "Invoice" : null, "Line" : { "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial" : null } ], "Status" : 0, "ErrorMessage" : null, "EstimatedFreight" : null, "InsurableValue" : { "Value" : 39.8800, "Units" : 0 }, "Tracking" : null, "Invoices" : [], "Packingslip" : null, "Labels" : null, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "ShipAt" : "2015-03-06T00:00:00", "UserDefined1" : null, "UserDefined2" : null, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "CarrierAccountDetails" : null, "SSCC" : null } ], "Invoices" : [], "Cancelations" : [], "Notes" : null, "Comments" : [], "Group" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "Type" : 1, "PurchaseOrderNumber" : "PoNumber", "ReferenceNumber" : "ReferenceNumber", "EndCustomerReferenceNumber" : "EndCustomerReferenceNumber", "ShipTo" : { "IsResidential" : false, "Company" : "", "Attention" : "AttentionName", "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345-1234", "State" : "FL", "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 }, "CreatedAt" : "2015-03-06T23:53:49.183", "Type" : 1, "ReferenceNumber" : null, "BillTo" : { "Company" : "CompanyName", "Attention" : null, "PhoneNumber" : null, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "Sample Suite 123", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "SpecialInstructions" : null, "SignatureOption" : 0, "InsuranceOption" : 0, "FOB" : 10, "CarrierMethod" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Carrier" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "AccountDetails" : null, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "Payments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "PaymentInfo" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "PaymentMethodCode", "Name" : "PaymentMethodName" }, "Amount" : { "Value" : 79.7600, "Units" : 0 }, "CreditCardInfo" : null } ], "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" } ], "TransactionId" : null, "TransactionTime" : "2015-12-31T18:39:35.1681699Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of purchase order results. | PurchaseOrderResult[] |
| 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 Orders By Retailer
This service allows a partner to retrieve a paged list of orders received by a specific retailer.
URLhttps://api.getquipt.com/v2/orders/fulfillment/channel/{retailerId}/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {retailerId} | Either the Quipt identifier for the retailer, or the code set as the partner reference within the partner's settings. | Guid | Yes |
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &include | A comma separated list of properties to include with result. Valid options are Invoices, Shipments, Cancellations, PackingSlips, ShipByTruckRequests, Payments, Fulfillments, Acknowledgements, and SubstitutionFor. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.comv2/orders/fulfillment/channel/00000000-0000-0000-0000-000000000000/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 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
{ "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : false }, "Result" : [{ "SourcedBy" : [], "SubTotal" : { "Value" : 79.76000000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Total" : { "Value" : 79.76000000, "Units" : 0 }, "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "RemitTo" : { "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "FaxNumber" : null, "Company" : "CompanyName", "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "FreightCollection" : 1, "Status" : 4, "SubStatus" : 0, "Lines" : [{ "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "Packingslips" : null, "ShipByTruckRequests" : [], "Shipments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "Fills" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 2, "PickStatus" : 0, "VendorSKU" : "SampleSKU", "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Cost" : { "Value" : 0.0000, "Units" : 0 }, "Invoice" : null, "Line" : { "Fulfillments" : [{ "VendorSKU" : "SampleSKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [] } ], "Acknowledgements" : [], "Item" : { "Title" : "SampleTitle", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "ConditionName", "Code" : "ConditionCode" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SampleSKU", "Vendor" : { "Code" : "MerchantCode", "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" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.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" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial" : null } ], "Status" : 0, "ErrorMessage" : null, "EstimatedFreight" : null, "InsurableValue" : { "Value" : 39.8800, "Units" : 0 }, "Tracking" : null, "Invoices" : [], "Packingslip" : null, "Labels" : null, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "City Name", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "ShipAt" : "2015-03-06T00:00:00", "UserDefined1" : null, "UserDefined2" : null, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "CarrierAccountDetails" : null, "SSCC" : null } ], "Invoices" : [], "Cancelations" : [], "Notes" : null, "Comments" : [], "Group" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Channel" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "Type" : 1, "PurchaseOrderNumber" : "PoNumber", "ReferenceNumber" : "ReferenceNumber", "EndCustomerReferenceNumber" : "EndCustomerReferenceNumber", "ShipTo" : { "IsResidential" : false, "Company" : "", "Attention" : "AttentionName", "PhoneNumber" : { "CountryISO" : "US", "Number" : "1234567890" }, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345-1234", "State" : "FL", "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 }, "CreatedAt" : "2015-03-06T23:53:49.183", "Type" : 1, "ReferenceNumber" : null, "BillTo" : { "Company" : "CompanyName", "Attention" : null, "PhoneNumber" : null, "EmailAddress" : null, "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "Sample Suite 123", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "SpecialInstructions" : null, "SignatureOption" : 0, "InsuranceOption" : 0, "FOB" : 10, "CarrierMethod" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Carrier" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierName", "Code" : "CarrierCode" }, "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "AccountDetails" : null, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "Payments" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "PaymentInfo" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "PaymentMethodCode", "Name" : "PaymentMethodName" }, "Amount" : { "Value" : 79.7600, "Units" : 0 }, "CreditCardInfo" : null } ], "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" } ], "TransactionId" : null, "TransactionTime" : "2015-12-31T18:39:35.1681699Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of purchase order results. | PurchaseOrderResult[] |
| 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[] |
Acknowledge
This service provides a mechanism to acknowledge an order. Use service provides the mechanisms to either accept and reject an order.
URLhttps://api.getquipt.com/v2/orders/fulfillment/acknowledge
Methodpost
Body Definitions:
| Name | Description | Type |
|---|---|---|
| Acknowledgements | The collection of purchase order acknowledgements for the request. | PurchaseOrder.Acknowledgement[] |
| TransactionId | The transaction id for the request. | String |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/orders/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 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 |
{ "Acknowledgements" : [{ "Order" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" }, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "WarehouseCode", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Lines" : [{ "SKU" : "SampleSKU", "Accepted" : { "ExpectedShipDate" : "2016-01-04T13:29:15.9606562-08:00", "Quantity" : { "Units" : 0, "Value" : 0.0 } }, "Rejected" : { "ReasonCode" : "ReasonCode", "ReasonText" : "ReasonText", "Serials" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Number" : "SampleNumber", "Location" : "SampleLocation", "UserDefined1" : null, "StartAt" : "2016-01-04T13:29:15.9606562-08:00", "Age" : 0 } ], "Quantity" : { "Units" : 0, "Value" : 0.0 } }, "BackOrdered" : { "PromisedDate" : "2016-01-04T13:29:15.9606562-08:00", "Quantity" : { "Units" : 0, "Value" : 0.0 } }, "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" : "2015-12-29T17:01:30.0863117Z", "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[] |
Ship
This service allows a partner apply shipment details to an order.
URLhttps://api.getquipt.com/v2/orders/fulfillment/ship
Methodpost
Parameters:
| Name | Description | Type |
|---|---|---|
| Shipments | The collection of purchase order shipment details for the request. | PurchaseOrder.Shipment[] |
| TransactionId | The transaction id for the request. | String |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/orders/fulfillment/ship 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 |
{ "Shipments" : [{ "Order" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" }, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "WarehouseCode", "Address" : { "City" : "CityName", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Packages" : [{ "Lines" : [{ "SKU" : "SampleSKU", "Shipped" : { "Units" : 0, "Value" : 0.0 }, "Serials" : ["SampleSerial"], "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "CarrierMethod" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Carrier" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "CarrierMethodName", "Code" : "CarrierMethodCode" }, "Name" : "CarrierName", "Code" : "CarroerCode" }, "TrackingNumber" : "SampleTrackingNumber", "Shipping" : { "Value" : 0.0, "Units" : 0 } } ], "Invoice" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber" : "SampleInvoiceNumber", "InvoicedAt" : "2016-01-04T13:29:16.0856751-08:00" } } ], "TransactionId" : null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived" : 1, "TransactionId" : null, "TransactionTime" : "2015-12-29T17:08:44.7209135Z", "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[] |
Invoice
This service provides a mechanism to invoice of shipped orders. Invoicing an orders is required, but it is not required to be completed using this service. If this flow cannot be supported turn ‘On’ auto invoicing within company settings.
URLhttps://api.getquipt.com/v2/orders/fulfillment/invoice
Methodpost
Parameters:
| Name | Description | Type |
|---|---|---|
| Invoices | The collection of purchase order invoices for the request. | PurchaseOrder.Invoice[] |
| TransactionId | The transaction id for the request. | String |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/orders/fulfillment/invoice 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 |
{ "Invoices" : [{ "Order" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Vendor" : { "Code" : "MerchantCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "MerchantName" }, "Channel" : { "Code" : "RetailerCode", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "RetailerName" }, "PurchaseOrderNumber" : "PoNumber" }, "Lines" : [{ "Invoiced" : { "Units" : 0, "Value" : 0.0 }, "Price" : { "Value" : 0.0, "Units" : 0 }, "SKU" : "SampleSKU", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ], "InvoiceNumber" : "SampleInvoiceNumber", "InvoicedAt" : "2015-12-29T09:15:49.2076357-08:00", "Shipping" : { "Value" : 0.0, "Units" : 0 }, "Tax" : { "Value" : 0.0, "Units" : 0 }, "Discount" : { "Value" : 0.0, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0, "Units" : 0 }, "Total" : { "Value" : 0.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" : "2015-12-29T17:16:26.0673391Z", "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 an order. The primary purpose of archiving an order is to remove it from the lists that are obtained using ‘Get Orders’ and ‘Get Orders By Channel’. This mechanism is not required, and will be automatically applied after 30 days.
URLhttps://api.getquipt.com/v2/orders/fulfillment/archive
Methodpost
Parameters:
| Name | Description | Type |
|---|---|---|
| PurchaseOrderIds | The collection of purchase order ids for the request. | Guid[] |
| TransactionId | The transaction id for the request. | String |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/orders/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 |
{ "PurchaseOrderIds" : ["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" : "2015-12-29T17:21:48.6201131Z", "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 Order’, ‘Ship Order’, ‘Invoice Order’, and ‘Archive Order’ 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 4 |
GET https://api.getquipt.com/v2/orders/fulfillment/report/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/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 |
{ "Result" : [ { "PurchaseOrderId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "PurchaseOrderLineId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 64, "Message" : "Carrier updated based on policy. Carrier account details updated based on policy. Signature option updated based on partner policy. Signature option updated based on partner policy. FOB updated based on policy. Payment updated based on policy. Carrier account details updated based on policy. Payment updated based on policy.", "Record" : 1 } ], "ReportId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "ReportTime" : "2014-07-03T20:33:45.48", "ReportStatus" : 64, "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : false }, "TransactionId" : null, "TransactionTime" : "2015-12-29T17:27:06.0859231Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The collection of purchase order reports. | PurchaseOrderReport[] |
| 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[] |