Skip to main content

Set Order Number

Provides the possibility to set a new Order number for a specific invoice. The order number can be used to search for a specific order in the Collector Partner Portal.

The invoice number is the number returned in the AddInvoice response.

Please Note

It is only possible to set a new order number on an invoice in state Pending. Activated invoices cannot be updated with a new order number.

Request Parameters#

FieldOccursnullableMaxTypeDescription
Password1false50stringThe password used to authorize the request.
Username1false50stringThe username used to authorize the request.
CorrelationId1true50stringCorrelationID is sent back in the response.
CountryCode1false2stringThe country code (ISO 3166-1 alpha-2) for country.
InvoiceNo1false10stringThe invoice number returned from AddInvoice
NewOrderNumber1false20stringThe order's new identification that can be used to search for a
specific order in the Collector Partner Portal.
StoreId1true-intThe StoreId used for identification of store.

Response Parameters#

FieldOccursnullableMaxTypeDescription
CorrelationId1true50stringCorrelationID from the request if any.

Example Requests#

 Value
Environment:UAT
Service:PaymentService
URL:https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl
Function:SetOrderNumber
Description:The operation sets a new or updates an existing order number of an invoice
Notes:N/A
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pay="http://schemas.ecommerce.collector.se/v30/PaymentService">
<soapenv:Header>
<pay:Username>USERNAME</pay:Username>
<pay:Password>PASSWORD</pay:Password>
</soapenv:Header>
<soapenv:Body>
<pay:SetOrderNumberRequest>
<!--Optional:-->
<pay:CorrelationId>dff41cfc-5c36-4c10-9573-3a2c4c695d31</pay:CorrelationId>
<!--Optional:-->
<pay:CountryCode>SE</pay:CountryCode>
<!--Optional:-->
<pay:InvoiceNo>68223728</pay:InvoiceNo>
<!--Optional:-->
<pay:NewOrderNumber>Order123456</pay:NewOrderNumber>
<!--Optional:-->
<pay:StoreId>1234</pay:StoreId>
</pay:SetOrderNumberRequest>
</soapenv:Body>
</soapenv:Envelope>

Error Codes#

Fault CodeDescription
AUTHORIZATION_FAILEDCould not authorize the request, check your login credentials. Please contact Collector for more help
INVOICE_NOT_FOUNDThe specified invoice number cannot be found
VALIDATION_COUNTRY_CODE_REQUIREDCountry code is not provided in the request
VALIDATION_INVOICE_NUMBER_REQUIREDInvoice number is ont provided in the request