Przejdź do głównej zawartości

Obsłuż skan kodu dla zamówienia

POST
/api/v6/Orders/code-scan/{scannedValue}
curl --request POST \
--url https://twoja-instancja-smerp-api.enterprise.sellrocket.pl/api/v6/Orders/code-scan/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reserve": true, "mode": "Pack", "packStationId": 1, "additionalFieldName": "example" }'

Przetwarza zeskanowany kod w kontekście procesu kompletacji/pakowania i zwraca wynik dopasowania. Używane głównie przez panel Sellrocket.

scannedValue
wymagane
string
Typ treściapplication/json
object
reserve
boolean
mode
string
Dozwolone wartości: Pack Pick
packStationId
integer format: int64
nullable
additionalFieldName
string
nullable

Success

Typ treściapplication/json
object
reserveJobId
integer format: int64
matchedOrder
object
id
integer format: int64
source
object
connectionId
integer format: int64
nullable
connectionType
string
nullable
platformAccountId
string
nullable
platformOrderId
string
nullable
externalSourceId
string
nullable
externalSourceType
string
nullable
sourceOrderId
string
nullable
asteriskMarked
boolean
asteriskKindId
integer format: int64
asteriskKindColor
string
nullable
asteriskKindIcon
string
nullable
sellerComments
string
nullable
buyerComments
string
nullable
platformDateAddedUtc
string format: date-time
platformDateConfirmedUtc
string format: date-time
nullable
seller
object
email
string
nullable
username
string
nullable
fullName
string
nullable
companyName
string
nullable
rawCompanyTaxId
string
nullable
phone
string
nullable
buyer
object
email
string
nullable
username
string
nullable
fullName
string
nullable
companyName
string
nullable
rawCompanyTaxId
string
nullable
phone
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
payments
object
paymentStatus
string
Dozwolone wartości: Unpaid Paid Incorrect
paymentName
string
nullable
payments
Array<object>
nullable
object
id
integer format: int64
platformId
string
nullable
platformName
string
nullable
finishedAtUtc
string format: date-time
nullable
paymentAmount
object
currency
string
nullable
amount
number format: double
notRoundedAmount
number format: double
amountBefore
number format: double
change
number format: double
status
object
id
integer format: int64
from
string format: date-time
delivery
object
recipient
object
email
string
nullable
fullName
string
nullable
companyName
string
nullable
phone
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
pickupPoint
object
code
string
nullable
name
string
nullable
description
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
cost
object
currency
string
nullable
amount
number format: double
method
object
platformId
string
nullable
platformName
string
nullable
isCod
boolean
isPacked
boolean
isPicked
boolean
isBeingPacked
boolean
isBeingPicked
boolean
packedByUserId
integer format: int64
nullable
invoice
object
required
boolean
payer
object
email
string
nullable
username
string
nullable
fullName
string
nullable
companyName
string
nullable
rawCompanyTaxId
string
nullable
phone
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
lineItems
Array<object>
nullable
object
id
integer format: int64
platformId
string
nullable
product
object
id
integer format: int64
nullable
platformId
string
nullable
name
string
nullable
code
string
nullable
ean
string
nullable
bundleId
string
nullable
warehouseId
string
nullable
parentName
string
nullable
additionalEans
Array<object>
nullable
object
ean
string
nullable
quantity
number format: double
description
string
nullable
quantity
number format: double
tax
object
symbol
string
nullable
rate
number format: double
price
object
currency
string
nullable
unitPrice

Cena brutto

number format: double
originalUnitPrice
number format: double
elasticFields
Array<object>
nullable
object
fieldName
string
nullable
fieldValue
string
nullable
allegroOfferUrl
string
nullable
attachments
Array<object>
nullable
object
id
integer format: int64
orderId
integer format: int64
contentType
string
nullable
fileName
string
nullable
uri
string
nullable
bytesSize
integer format: int64
status
string
nullable
uploadType
string
nullable
invoiceNumber
string
nullable
ksef
object
number
string
nullable
summary
object
totalToPay
object
currency
string
nullable
amount
number format: double
toPayWithoutShipment
object
currency
string
nullable
amount
number format: double
ksef
object
errorMessage
string
nullable
status
string
nullable
orderIdFromWhichThisWasCreatedBySplit
integer format: int64
nullable
orderIdsWhichWereCreatedBySplitFromThis
Array<integer>
nullable
fulfillmentByMarketplace
boolean
nullable
return
object
returnedAtUtc
string format: date-time
nullable
reason
string
nullable
mergedOrders
Array<object>
nullable
object
id
integer format: int64
connectionPlatformOrderId
string
nullable
connectionId
integer format: int64
nullable
currency
string
nullable
additionalField1
string
nullable
additionalField2
string
nullable
shipments
Array<object>
nullable
object
id
integer format: int64
nullable
shipmentId
string
nullable
dateAddedUtc
string format: date-time
nullable
courierCode
string
nullable
trackingNumber
string
nullable
externalCarrierTrackingNumber
string
nullable
status
string
nullable
connectionId
string
nullable
courierConnectionType
string
nullable
courierService
string
nullable
trackingUrl
string
nullable
courierTransport
Array<string>
nullable
deliveryMethodPlatformId
string
nullable
shippingDate
string format: date
nullable
isReturn
boolean
nullable
returnId
integer format: int64
nullable
connection
object
id
integer format: int64
name
string
nullable
connectionType
string
nullable
externalSourceType
string
nullable
externalSourceTypeName
string
nullable
externalSourceId
string
nullable
isConfigured
boolean
isSystemTool
boolean
positionInDefinition
object
position
integer format: int64
createdAt
string format: date-time
courierPickup
boolean
cancellation
object
cancelledAtUtc
string format: date-time
nullable
reason
string
nullable
packStation
object
id
integer format: int64
name
string
nullable
printers
Array<object>
nullable
object
id
integer format: int64
printerId
integer format: int64
printerName
string
nullable
computerName
string
nullable
position
integer format: int32
returnIds
Array<integer>
nullable
elasticFields
Array<object>
nullable
object
objectId
integer format: int64
ownerType
string
nullable
definitionId
integer format: int64
nullable
fieldType
string
nullable
fieldName
string
nullable
fieldDisplayName
string
nullable
fieldValue
string
nullable
Example
{
"matchedOrder": {
"payments": {
"paymentStatus": "Unpaid"
}
}
}

Not Found

Typ treściapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Conflict

Typ treściapplication/json
object
reserveJobId
integer format: int64
matchedOrder
object
id
integer format: int64
source
object
connectionId
integer format: int64
nullable
connectionType
string
nullable
platformAccountId
string
nullable
platformOrderId
string
nullable
externalSourceId
string
nullable
externalSourceType
string
nullable
sourceOrderId
string
nullable
asteriskMarked
boolean
asteriskKindId
integer format: int64
asteriskKindColor
string
nullable
asteriskKindIcon
string
nullable
sellerComments
string
nullable
buyerComments
string
nullable
platformDateAddedUtc
string format: date-time
platformDateConfirmedUtc
string format: date-time
nullable
seller
object
email
string
nullable
username
string
nullable
fullName
string
nullable
companyName
string
nullable
rawCompanyTaxId
string
nullable
phone
string
nullable
buyer
object
email
string
nullable
username
string
nullable
fullName
string
nullable
companyName
string
nullable
rawCompanyTaxId
string
nullable
phone
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
payments
object
paymentStatus
string
Dozwolone wartości: Unpaid Paid Incorrect
paymentName
string
nullable
payments
Array<object>
nullable
object
id
integer format: int64
platformId
string
nullable
platformName
string
nullable
finishedAtUtc
string format: date-time
nullable
paymentAmount
object
currency
string
nullable
amount
number format: double
notRoundedAmount
number format: double
amountBefore
number format: double
change
number format: double
status
object
id
integer format: int64
from
string format: date-time
delivery
object
recipient
object
email
string
nullable
fullName
string
nullable
companyName
string
nullable
phone
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
pickupPoint
object
code
string
nullable
name
string
nullable
description
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
cost
object
currency
string
nullable
amount
number format: double
method
object
platformId
string
nullable
platformName
string
nullable
isCod
boolean
isPacked
boolean
isPicked
boolean
isBeingPacked
boolean
isBeingPicked
boolean
packedByUserId
integer format: int64
nullable
invoice
object
required
boolean
payer
object
email
string
nullable
username
string
nullable
fullName
string
nullable
companyName
string
nullable
rawCompanyTaxId
string
nullable
phone
string
nullable
address
object
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
fullNumber
string
nullable
isEu
boolean
nullable
lineItems
Array<object>
nullable
object
id
integer format: int64
platformId
string
nullable
product
object
id
integer format: int64
nullable
platformId
string
nullable
name
string
nullable
code
string
nullable
ean
string
nullable
bundleId
string
nullable
warehouseId
string
nullable
parentName
string
nullable
additionalEans
Array<object>
nullable
object
ean
string
nullable
quantity
number format: double
description
string
nullable
quantity
number format: double
tax
object
symbol
string
nullable
rate
number format: double
price
object
currency
string
nullable
unitPrice

Cena brutto

number format: double
originalUnitPrice
number format: double
elasticFields
Array<object>
nullable
object
fieldName
string
nullable
fieldValue
string
nullable
allegroOfferUrl
string
nullable
attachments
Array<object>
nullable
object
id
integer format: int64
orderId
integer format: int64
contentType
string
nullable
fileName
string
nullable
uri
string
nullable
bytesSize
integer format: int64
status
string
nullable
uploadType
string
nullable
invoiceNumber
string
nullable
ksef
object
number
string
nullable
summary
object
totalToPay
object
currency
string
nullable
amount
number format: double
toPayWithoutShipment
object
currency
string
nullable
amount
number format: double
ksef
object
errorMessage
string
nullable
status
string
nullable
orderIdFromWhichThisWasCreatedBySplit
integer format: int64
nullable
orderIdsWhichWereCreatedBySplitFromThis
Array<integer>
nullable
fulfillmentByMarketplace
boolean
nullable
return
object
returnedAtUtc
string format: date-time
nullable
reason
string
nullable
mergedOrders
Array<object>
nullable
object
id
integer format: int64
connectionPlatformOrderId
string
nullable
connectionId
integer format: int64
nullable
currency
string
nullable
additionalField1
string
nullable
additionalField2
string
nullable
shipments
Array<object>
nullable
object
id
integer format: int64
nullable
shipmentId
string
nullable
dateAddedUtc
string format: date-time
nullable
courierCode
string
nullable
trackingNumber
string
nullable
externalCarrierTrackingNumber
string
nullable
status
string
nullable
connectionId
string
nullable
courierConnectionType
string
nullable
courierService
string
nullable
trackingUrl
string
nullable
courierTransport
Array<string>
nullable
deliveryMethodPlatformId
string
nullable
shippingDate
string format: date
nullable
isReturn
boolean
nullable
returnId
integer format: int64
nullable
connection
object
id
integer format: int64
name
string
nullable
connectionType
string
nullable
externalSourceType
string
nullable
externalSourceTypeName
string
nullable
externalSourceId
string
nullable
isConfigured
boolean
isSystemTool
boolean
positionInDefinition
object
position
integer format: int64
createdAt
string format: date-time
courierPickup
boolean
cancellation
object
cancelledAtUtc
string format: date-time
nullable
reason
string
nullable
packStation
object
id
integer format: int64
name
string
nullable
printers
Array<object>
nullable
object
id
integer format: int64
printerId
integer format: int64
printerName
string
nullable
computerName
string
nullable
position
integer format: int32
returnIds
Array<integer>
nullable
elasticFields
Array<object>
nullable
object
objectId
integer format: int64
ownerType
string
nullable
definitionId
integer format: int64
nullable
fieldType
string
nullable
fieldName
string
nullable
fieldDisplayName
string
nullable
fieldValue
string
nullable
Example
{
"matchedOrder": {
"payments": {
"paymentStatus": "Unpaid"
}
}
}

Server Error