services['api_platform.action.documentation'] = new \ApiPlatform\Symfony\Action\DocumentationAction(($container->privates['api_platform.metadata.resource.name_collection_factory.cached'] ?? self::getApiPlatform_Metadata_Resource_NameCollectionFactory_CachedService($container)), 'Fulfillment API', '

General notes

Authentication

You can authenticate to the API by providing your API key in the header

HTTPS only

All requests must be made over HTTPS. Calls made over plain HTTP will fail.

UTF-8

Text data is encoded as UTF-8. You must use UTF-8 encoding for all requests and responses.

Date and time

Dates and times are returned in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ.'."\n".'In the patterns

YYYY : years (four digits)
MM : months, 01-12 (two digits)
DD : days, 01-31 (two digits)
T : is a delimiter between the date and time
hh : hours, 00-23 (two digits)
mm : minutes, 00-59 (two digits)
ss : seconds, 00-60 (two digits)
±hh:mm : refers to an offset from UTC

'."\n".'

Api return codes

Success Codes

200: OK - Request succeeded.
201: Created - Request succeeded and resource created.
202: Accepted - Request accepted for processing.
204: No Content - Request succeeded but does not return any content.

Error Codes

400

Bad Request - Parameter errors or bad method usage.

Bad usage of the resource. For example: a required parameter is missing, some parameters use an incorrect format, a data query is not in the expected state.

401

Unauthorized - API call without authentication.

Add authentication information or use a valid authentication token.

403

Forbidden - Access to the resource is denied.

Current user can not access the resource.

404

Not Found - The resource does not exist.

The resource URI or the requested resource do not exist for the current user.

405

Method Not Allowed - The HTTP method (GET, POST, PUT, DELETE) is not allowed for this resource.

Refer to the documentation for the list of accepted methods.

406

Not Acceptable - The requested response content type is not available for this resource.

Refer to the documentation for the list of correct values of the Accept header for this request.

410

Gone - The resource is permanently gone.

The requested resource is no longer available and will not be available again.

415

Unsupported Media Type - The entity content type sent to the server is not supported.

Refer to the documentation for the list of correct values of the Content-type header to send data.

422

Unprocessable entity - The action cannot be made on the entity.

429

Too many requests - Rate limits are exceeded.

The user has sent too many requests in the last hour. Login and forgot password API are limited to 10 requests per hours all other are limited to 1000 requests per hour.

500

Internal Server Error - The server encountered an unexpected error.

', '1.2.3', ($container->privates['App\\ApiPlatform\\OpenApi\\OpenApiFactory'] ?? $container->load('getOpenApiFactoryService')), ($container->privates['api_platform.state_provider.content_negotiation'] ?? $container->load('getApiPlatform_StateProvider_ContentNegotiationService')), ($container->privates['api_platform.state_processor.validate'] ?? $container->load('getApiPlatform_StateProcessor_ValidateService')), ($container->privates['api_platform.negotiator'] ??= new \Negotiation\Negotiator()), $container->parameters['api_platform.docs_formats'], false, true, true, true); } }